Package wt.configurablelink

Interface ConfigurableLinkService

All Known Implementing Classes:
StandardConfigurableLinkService
@RemoteInterface public interface ConfigurableLinkService


Supported API: true

Extendable: false

  • Method Details

    • createConfigurableMastersLink

      WTCollection createConfigurableMastersLink(WTReference roleAObjectRef, TypeIdentifier configLinkTypeId, WTCollection roleBObjects) throws WTException
      Creates associations between the specified Role A and Role B objects using ConfigurableMastersLink of the specified type. An exception is raised if 1) Role A object is not an Iterated or Mastered type 2) Any of the Role B objects are not Iterated or Mastered type 3) Any of the Role B objects are not valid as per the existing association constraints for the given Role A and link type

      Supported API: true
      Parameters:
      roleAObjectRef - The Role A side of the link. This can be an Iterated or Mastered object reference. If it is an Iterated object, master will be derived from it for creating the associations.
      configLinkTypeId - The type of link to be used for the association. It must a subtype of ConfigurableMastersLink
      roleBObjects - This is a collection of objects that represent the Role B side of the link. It can contain a mix of WTReferences and Persistables. The Role B objects can be Iterated or Mastered. If Iterated objects are supplied, masters are derived from them for creating the associations.
      Returns:
      WTCollection
      Throws:
      WTException

    • createConfigurableDescribeLink

      WTCollection createConfigurableDescribeLink(WTReference roleAObjectRef, TypeIdentifier configLinkTypeId, WTCollection roleBObjects, boolean keepCheckedOut) throws WTException
      Creates associations between the specified Role A and Role B objects usnig the specified ConfigurableDescribeLink type. An exception is raised if 1) Role A object is not an Iterated type 2) Any of the Role B objects are not Iterated type 3) Any of the Role B objects are not valid as per the existing association constraints for the given Role A and link type The association is created between the latest iteration of the Role A object and the latest iterations of the Role B objects. Role A object is checked out if it is not already checked out.

      Supported API: true
      Parameters:
      roleAObjectRef - The Role A side of the link. This must be a reference to an Iterated object.
      configLinkTypeId - The type of link to be used for the association. It must a subtype of ConfigurableDescribeLink
      roleBObjects - This is a collection of objects that represent the Role B side of the link. It can contain a mix of WTReferences and Persistables. All the Role B objects must be Iterated.
      keepCheckedOut - If the Role A object is checked out by the API, this parameter determines if the object is checked back in or is kept checked out. If the Role A object passed in to this API is already checked out then this parameter is ignored.
      Returns:
      WTCollection
      Throws:
      WTException

    • createConfigurableReferenceLink

      WTCollection createConfigurableReferenceLink(WTReference roleAObjectRef, TypeIdentifier configLinkTypeId, WTCollection roleBObjects, boolean keepCheckedOut) throws WTException
      Creates associations between the specified Role A and Role B objects using ConfigurableReferenceLink of the specified type. An exception is raised if 1) Role A object is not an Iterated type 2) Any of the Role B objects are not Iterated or Mastered type 3) Any of the Role B objects are not valid as per the existing association constraints for the given Role A and link type The association is created between the latest iteration of the Role A object and the Role B objects' masters. Role A object is checked out if it is not already checked out.

      Supported API: true
      Parameters:
      roleAObjectRef - The Role A side of the link. This must be a reference to an Iterated object.
      configLinkTypeId - The type of link to be used for the association. It must a subtype of ConfigurableReferenceLink
      roleBObjects - This is a collection of objects that represent the Role B side of the link. It can contain a mix of WTReferences and Persistables. The Role B objects can be Iterated or Mastered. If Iterated objects are supplied, masters are derived from them for creating the associations.
      keepCheckedOut - If the Role A object is checked out by the API, this parameter determines if the object is checked back in or is kept checked out. If the Role A object passed in to this API is already checked out then this parameter is ignored.
      Returns:
      WTCollection
      Throws:
      WTException

    • createConfigurableRevisionLink

      WTCollection createConfigurableRevisionLink(WTReference roleAObjectRef, TypeIdentifier configLinkTypeId, WTCollection roleBObjects) throws WTException
      Creates associations between the specified Role A and Role B objects using ConfigurableReferenceLink of the specified type. An exception is raised if 1) Role A object is not an Iterated type 2) Any of the Role B objects are not Iterated types 3) Any of the Role B objects are not valid as per the existing association constraints for the given Role A and link type The links are created between the ControlBranch of the Role A object ControlBranch of the Role B objects

      Supported API: true
      Parameters:
      roleAObjectRef - The Role A side of the link. This must be a reference to an Iterated object.
      configLinkTypeId - The type of link to be used for the association. It must a subtype of ConfigurableRevisionLink
      roleBObjects - This is a collection of objects that represent the Role B side of the link. It can contain a mix of WTReferences and Persistables. The Role B objects must be Iterated.
      Returns:
      WTCollection
      Throws:
      WTException

    • getOtherSideObjectsFromLink

      QueryResult getOtherSideObjectsFromLink(WTReference roleObjectRef, TypeIdentifier configLinkTypeId, String roleSide, boolean onlyOtherSide, boolean includeSubTypes) throws WTException
      Returns the Role A or B objects for the specified role A/B object and the configurable link type. Caller can specify if only the otherside objects are to be returned or the link should also be returned.

      Supported API: true
      Parameters:
      roleObjectRef -
      configLinkTypeId -
      roleSide - Must be either BinaryLink.ROLE_AOBJECT_ROLE or BinaryLink.ROLE_BOBJECT_ROLE.
      onlyOtherSide -
      includeSubTypes -
      Returns:
      QueryResult
      Throws:
      WTException

    • getOtherSideObjectsFromLink

      QueryResult getOtherSideObjectsFromLink(WTReference roleObjectRef, TypeIdentifier configLinkTypeId, String roleSide, boolean onlyOtherSide) throws WTException
      Returns the Role A or B objects for the specified role A/B object and the configurable link type. Caller can specify if only the otherside objects are to be returned or the link should also be returned.

      Supported API: true
      Parameters:
      roleObjectRef -
      configLinkTypeId -
      roleSide - Must be either BinaryLink.ROLE_AOBJECT_ROLE or BinaryLink.ROLE_BOBJECT_ROLE.
      onlyOtherSide -
      Returns:
      QueryResult
      Throws:
      WTException