|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectcom.sap.mdm.commands.AbstractCommandBase
com.sap.mdm.commands.AbstractCommand
com.sap.mdm.session.AbstractSessionCommand
com.sap.mdm.session.AbstractUserSessionCommand
com.sap.mdm.data.commands.RetrieveRelationshipsCommand
This command allows for retrieving relationships related to the specified anchor record. If member records are loaded then they can be sorted according to sort definition that is specified in the member result definition. The sorting is applicable only if relationship property 'HasPosition' is false, otherwise the sort definition ignored.
ModifyRelationshipsCommand| Constructor Summary | |
RetrieveRelationshipsCommand(ConnectionAccessor connection)
Constructor. |
|
RetrieveRelationshipsCommand(UserSessionContext ctx)
Creates a new instance of this command by context. |
|
| Method Summary | |
Record |
getAnchorRecord()
Returns the anchor record. |
RecordId |
getAnchorRecordId()
Returns the ID of anchor record. |
ResultDefinition |
getAnchorResultDefinition()
Returns the result definition for anchor record. |
ResultDefinition[] |
getAnchorSupportingResultDefinitions()
Returns the list of result definitions for anchor record. |
ResultDefinition |
getMemberResultDefinition()
Returns the result definition for member records. |
ResultDefinition[] |
getMemberSupportingResultDefinitions()
Returns the list of result definitions for member records. |
RelationshipGroup |
getRelationshipGroup()
Returns relationship group as the result of the command. |
RelationshipId |
getRelationshipId()
Returns the relationship ID. |
boolean |
isGetChildren()
Indicates whether only child relationships are retrieved. |
boolean |
isLoadRecords()
Specifies if relationship records should be also loaded from the repository together with record IDs. |
void |
setAnchorRecord(Record anchorRecord)
Sets the anchor record (required*). |
void |
setAnchorRecordId(RecordId anchorRecordId)
Sets ID of the anchor record (required*). |
void |
setAnchorResultDefinition(ResultDefinition anchorResultDefinition)
Sets the result definition for anchor record (optional). |
void |
setAnchorSupportingResultDefinitions(ResultDefinition[] anchorSupportingResultDefinitions)
Sets the list of result definitions for anchor record (optional). |
void |
setGetChildren(boolean getChildren)
Specify if only child relationships are retrieved (optional). |
void |
setLoadRecords(boolean loadRecords)
Specifies if relationship records should be also loaded from the repository together with record IDs (optional). |
void |
setMemberResultDefinition(ResultDefinition memberResultDefinition)
Sets the result definition for member records (optional). |
void |
setMemberSupportingResultDefinitions(ResultDefinition[] memberSupportingResultDefinitions)
Sets the list of result definitions for member records (optional). |
void |
setRelationshipId(RelationshipId relationshipId)
Sets the relationship ID (required). |
| Methods inherited from class com.sap.mdm.commands.AbstractCommand |
getSession, setSession |
| Methods inherited from class com.sap.mdm.commands.AbstractCommandBase |
execute, getPassport, isCommandComplete, setPassport |
| Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public RetrieveRelationshipsCommand(ConnectionAccessor connection)
connection - the connection to the MDM server
public RetrieveRelationshipsCommand(UserSessionContext ctx)
throws ConnectionException,
SessionException
ctx - the user session context.| Method Detail |
public RelationshipId getRelationshipId()
public void setRelationshipId(RelationshipId relationshipId)
relationshipId - the relationship IDpublic RecordId getAnchorRecordId()
public void setAnchorRecordId(RecordId anchorRecordId)
anchorRecordId - the anchor record IDpublic Record getAnchorRecord()
public void setAnchorRecord(Record anchorRecord)
anchorRecord - the anchor recordpublic boolean isGetChildren()
true if children are returned, false if parents are returnedpublic void setGetChildren(boolean getChildren)
true.
This parameter is relevant only for 'parent/child' relationship, it is ignored for 'sibling' relationship
getChildren - true if children should be returned,
false if parents should be returnedpublic boolean isLoadRecords()
true if record are retrieved, false otherwisepublic void setLoadRecords(boolean loadRecords)
false.
loadRecords - public ResultDefinition getMemberResultDefinition()
AbstractRetrieveLimitedRecordsCommand.getSupportingResultDefinitions()public void setMemberResultDefinition(ResultDefinition memberResultDefinition)
memberResultDefinition - the result definitionAbstractRetrieveLimitedRecordsCommand.setSupportingResultDefinitions(ResultDefinition[])public ResultDefinition getAnchorResultDefinition()
AbstractRetrieveLimitedRecordsCommand.getSupportingResultDefinitions()public void setAnchorResultDefinition(ResultDefinition anchorResultDefinition)
anchorResultDefinition - the result definitionAbstractRetrieveLimitedRecordsCommand.setSupportingResultDefinitions(ResultDefinition[])public ResultDefinition[] getMemberSupportingResultDefinitions()
AbstractRetrieveLimitedRecordsCommand.getResultDefinition()public void setMemberSupportingResultDefinitions(ResultDefinition[] memberSupportingResultDefinitions)
memberSupportingResultDefinitions - the list of result definitionspublic ResultDefinition[] getAnchorSupportingResultDefinitions()
AbstractRetrieveLimitedRecordsCommand.getResultDefinition()public void setAnchorSupportingResultDefinitions(ResultDefinition[] anchorSupportingResultDefinitions)
anchorSupportingResultDefinitions - the list of result definitionspublic RelationshipGroup getRelationshipGroup()
RelationshipGroup
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
Copyright 2004-2007 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.
These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies (SAP Group) for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.