Package wt.change2.flexible

Interface FlexibleChangeService

@RemoteInterface
public interface FlexibleChangeService

Service support for flexible change associations.

Supported API: true

Extendable: false

Method Summary

Modifier and Type	Method	Description
WTSet	deleteFlexibleChangeLinks(FlexibleChangeItem item, String otherSideRole, boolean latest, TypeIdentifier linkType)	Delete flexible change links from role object.
WTSet	deleteFlexibleChangeLinks(WTCollection items, String otherSideRole, boolean latest, TypeIdentifier linkType)	Delete flexible change links from role objects.
WTSet	filterChangeItems(WTCollection items, boolean flexible)	Filter flexible or legacy change items from a mixed collection of change items.
WTSet	getFlexibleChangeItems(FlexibleChangeItem item, String otherSideRole, Boolean latest, TypeIdentifier linkType)	Get associated flexible change items.
WTSet	getFlexibleChangeItems(FlexibleChangeItem item, String otherSideRole, Boolean latest, TypeIdentifier linkType, Class<?> changeItemClass)	Get associated flexible change items.
WTSet	getFlexibleChangeItems(WTCollection items, String otherSideRole, Boolean latest, TypeIdentifier linkType)	Get associated flexible change items.
WTSet	getFlexibleChangeItems(WTCollection items, String otherSideRole, Boolean latest, TypeIdentifier linkType, Class<?> changeItemClass)	Get associated flexible change items.
WTSet	getFlexibleChangeLinks(FlexibleChangeItem item, String otherSideRole, Boolean latest, TypeIdentifier linkType)	Get flexible change links from role object.
WTSet	getFlexibleChangeLinks(FlexibleChangeItem item, String otherSideRole, Boolean latest, TypeIdentifier linkType, Class<?> changeItemClass)	Get flexible change links from role object.
WTSet	getFlexibleChangeLinks(WTCollection items, String otherSideRole, Boolean latest, TypeIdentifier linkType)	Get flexible change links from role objects.
WTSet	getFlexibleChangeLinks(WTCollection items, String otherSideRole, Boolean latest, TypeIdentifier linkType, Class<?> changeItemClass)	Get flexible change links from role objects.

Method Details

getFlexibleChangeItems

WTSet getFlexibleChangeItems(FlexibleChangeItem item,
 String otherSideRole,
 Boolean latest,
 TypeIdentifier linkType)
                      throws WTException

Get associated flexible change items.

Supported API: true

Parameters:

item - FlexibleChangeItem role object.

otherSideRole - Other side role being queried (e.g., flexibleChangeLink.PARENT_ROLE, FlexibleChangeLink.CHILD_ROLE, FlexibleChangeLink.ALL_ROLES).

latest - True for returning only latest revisions, false for returning only non-latest revisions, and null for all revisions.

linkType - WCTypeIdentifier for flexible change link type to be queried (null for all types).

Returns:

Set of associated FlexibleChangeItem objects (guaranteed non-null, may be empty).

Throws:

WTException

See Also:

• FlexibleChangeItem
• FlexibleChangeLink

getFlexibleChangeItems

WTSet getFlexibleChangeItems(FlexibleChangeItem item,
 String otherSideRole,
 Boolean latest,
 TypeIdentifier linkType,
 Class<?> changeItemClass)
                      throws WTException

Get associated flexible change items.

Supported API: true

Parameters:

item - FlexibleChangeItem role object.

otherSideRole - Other side role being queried (e.g., flexibleChangeLink.PARENT_ROLE, FlexibleChangeLink.CHILD_ROLE, FlexibleChangeLink.ALL_ROLES).

latest - True for returning only latest revisions, false for returning only non-latest revisions, and null for all revisions.

linkType - WCTypeIdentifier for flexible change link type to be queried (null for all types).

changeItemClass - Filter the result to only include change items of this type (null for all types).

Returns:

Set of associated FlexibleChangeItem objects (guaranteed non-null, may be empty).

Throws:

WTException

See Also:

• FlexibleChangeItem
• FlexibleChangeLink

getFlexibleChangeItems

WTSet getFlexibleChangeItems(WTCollection items,
 String otherSideRole,
 Boolean latest,
 TypeIdentifier linkType)
                      throws WTException

Get associated flexible change items.

Supported API: true

Parameters:

items - Collection of FlexibleChangeItem role objects.

otherSideRole - Other side role being queried (e.g., flexibleChangeLink.PARENT_ROLE, FlexibleChangeLink.CHILD_ROLE, FlexibleChangeLink.ALL_ROLES).

latest - True for returning only latest revisions, false for returning only non-latest revisions, and null for all revisions.

linkType - WCTypeIdentifier for flexible change link type to be queried (null for all types).

Returns:

Set of associated FlexibleChangeItem objects (guaranteed non-null, may be empty).

Throws:

WTException

See Also:

• FlexibleChangeItem
• FlexibleChangeLink

getFlexibleChangeItems

WTSet getFlexibleChangeItems(WTCollection items,
 String otherSideRole,
 Boolean latest,
 TypeIdentifier linkType,
 Class<?> changeItemClass)
                      throws WTException

Get associated flexible change items.

Supported API: true

Parameters:

items - Collection of FlexibleChangeItem role objects.

otherSideRole - Other side role being queried (e.g., flexibleChangeLink.PARENT_ROLE, FlexibleChangeLink.CHILD_ROLE, FlexibleChangeLink.ALL_ROLES).

latest - True for returning only latest revisions, false for returning only non-latest revisions, and null for all revisions.

linkType - WCTypeIdentifier for flexible change link type to be queried (null for all types).

changeItemClass - Filter the result to only include change items of this type (null for all types).

Returns:

Set of associated FlexibleChangeItem objects (guaranteed non-null, may be empty).

Throws:

WTException

See Also:

• FlexibleChangeItem
• FlexibleChangeLink

getFlexibleChangeLinks

WTSet getFlexibleChangeLinks(FlexibleChangeItem item,
 String otherSideRole,
 Boolean latest,
 TypeIdentifier linkType)
                      throws WTException

Get flexible change links from role object.

Supported API: true

Parameters:

item - FlexibleChangeItem role object.

otherSideRole - Other side role being queried (e.g., flexibleChangeLink.PARENT_ROLE, FlexibleChangeLink.CHILD_ROLE, FlexibleChangeLink.ALL_ROLES).

latest - True for returning only latest revisions, false for returning only non-latest revisions, and null for all revisions.

linkType - WCTypeIdentifier for flexible change link type to be queried (null for all types).

Returns:

Set of FlexibleChangeLink objects (guaranteed non-null, may be empty).

Throws:

WTException

See Also:

• FlexibleChangeItem
• FlexibleChangeLink

getFlexibleChangeLinks

WTSet getFlexibleChangeLinks(FlexibleChangeItem item,
 String otherSideRole,
 Boolean latest,
 TypeIdentifier linkType,
 Class<?> changeItemClass)
                      throws WTException

Get flexible change links from role object.

Supported API: true

Parameters:

item - FlexibleChangeItem role object.

otherSideRole - Other side role being queried (e.g., flexibleChangeLink.PARENT_ROLE, FlexibleChangeLink.CHILD_ROLE, FlexibleChangeLink.ALL_ROLES).

latest - True for returning only latest revisions, false for returning only non-latest revisions, and null for all revisions.

linkType - WCTypeIdentifier for flexible change link type to be queried (null for all types).

changeItemClass - Filter the result to only include links related to change items of this type (null for all types).

Returns:

Set of FlexibleChangeLink objects (guaranteed non-null, may be empty).

Throws:

WTException

See Also:

• FlexibleChangeItem
• FlexibleChangeLink

getFlexibleChangeLinks

WTSet getFlexibleChangeLinks(WTCollection items,
 String otherSideRole,
 Boolean latest,
 TypeIdentifier linkType)
                      throws WTException

Get flexible change links from role objects.

Supported API: true

Parameters:

items - Collection of FlexibleChangeItem role objects.

otherSideRole - Other side role being queried (e.g., flexibleChangeLink.PARENT_ROLE, FlexibleChangeLink.CHILD_ROLE, FlexibleChangeLink.ALL_ROLES).

latest - True for returning only latest revisions, false for returning only non-latest revisions, and null for all revisions.

linkType - WCTypeIdentifier for flexible change link type to be queried (null for all types).

Returns:

Set of FlexibleChangeLink objects (guaranteed non-null, may be empty).

Throws:

WTException

See Also:

• FlexibleChangeItem
• FlexibleChangeLink

getFlexibleChangeLinks

WTSet getFlexibleChangeLinks(WTCollection items,
 String otherSideRole,
 Boolean latest,
 TypeIdentifier linkType,
 Class<?> changeItemClass)
                      throws WTException

Get flexible change links from role objects.

Supported API: true

Parameters:

items - Collection of FlexibleChangeItem role objects.

otherSideRole - Other side role being queried (e.g., flexibleChangeLink.PARENT_ROLE, FlexibleChangeLink.CHILD_ROLE, FlexibleChangeLink.ALL_ROLES).

latest - True for returning only latest revisions, false for returning only non-latest revisions, and null for all revisions.

linkType - WCTypeIdentifier for flexible change link type to be queried (null for all types).

changeItemClass - Filter the result to only include change items of this type (null for all types).

Returns:

Set of FlexibleChangeLink objects (guaranteed non-null, may be empty).

Throws:

WTException

See Also:

• FlexibleChangeItem
• FlexibleChangeLink

filterChangeItems

WTSet filterChangeItems(WTCollection items,
 boolean flexible)
                 throws WTException

Filter flexible or legacy change items from a mixed collection of change items.

Supported API: true

Parameters:

items - Collection of flexible and legacy FlexibleChangeItem objects (will not be inflated).

flexible - True to filter for flexible change items, false to filter for legacy change items.

Returns:

Resulting set of flexible or legacy change items (guaranteed non-null, may be empty). The returned set will contain the same type of references as the input collection, with the same inflated state.

Throws:

WTException

See Also:

• FlexibleChangeItem

deleteFlexibleChangeLinks

WTSet deleteFlexibleChangeLinks(FlexibleChangeItem item,
 String otherSideRole,
 boolean latest,
 TypeIdentifier linkType)
                         throws WTException

Delete flexible change links from role object.

Supported API: true

Parameters:

item - FlexibleChangeItem role object.

otherSideRole - Other side role of links being deleted (e.g., flexibleChangeLink.PARENT_ROLE, FlexibleChangeLink.CHILD_ROLE, FlexibleChangeLink.ALL_ROLES).

latest - True for deleting only latest revisions of other side role objects, false for all revisions.

linkType - WCTypeIdentifier for flexible change link type to be deleted (null for all types).

Returns:

Set of FlexibleChangeLink objects deleted (guaranteed non-null, may be empty).

Throws:

WTException

See Also:

• FlexibleChangeItem
• FlexibleChangeLink

deleteFlexibleChangeLinks

WTSet deleteFlexibleChangeLinks(WTCollection items,
 String otherSideRole,
 boolean latest,
 TypeIdentifier linkType)
                         throws WTException

Delete flexible change links from role objects.

Supported API: true

Parameters:

items - Collection of FlexibleChangeItem role objects.

otherSideRole - Other side role of links being deleted (e.g., flexibleChangeLink.PARENT_ROLE, FlexibleChangeLink.CHILD_ROLE, FlexibleChangeLink.ALL_ROLES).

latest - True for deleting only latest revisions of other side role objects, false for all revisions.

linkType - WCTypeIdentifier for flexible change link type to be deleted (null for all types).

Returns:

Set of FlexibleChangeLink objects deleted (guaranteed non-null, may be empty).

Throws:

WTException

See Also:

• FlexibleChangeItem
• FlexibleChangeLink