com.edorasware.gear.core.workobject

Interface IdLookupService

All Known Implementing Classes:

DefaultIdLookupService

public interface IdLookupService

Provides lookup methods for mapping between different IDs.

Method Summary

Modifier and Type	Method and Description
String	getDefinitionIdForExternalId(String externalId) Returns the work object definition ID corresponding to the given external ID.
String	getExternalIdForDefinitionId(String definitionId) Returns the external definition ID corresponding to the given work object ID.
String	getExternalIdForWorkObjectId(String workObjectId) Returns the external ID corresponding to the given work object ID.
String	getGlobalIdForWorkObjectId(String workObjectId) Returns the global ID corresponding to the given work object ID value.
String	getWorkObjectIdForExternalId(String externalId) Returns the work object ID corresponding to the given external ID.
String	getWorkObjectIdForGlobalId(String globalId, String tenantId) Returns the work object ID corresponding to the given global ID.

Method Detail

getGlobalIdForWorkObjectId

String getGlobalIdForWorkObjectId(String workObjectId)

Returns the global ID corresponding to the given work object ID value.

The lookup is by value rather than the typed ID object as the type may be wrong.

Parameters:

workObjectId - a work object ID

Returns:

the corresponding global ID

Throws:

EntityNotFoundException - if there is no match

getWorkObjectIdForGlobalId

String getWorkObjectIdForGlobalId(String globalId,
                                  String tenantId)

Returns the work object ID corresponding to the given global ID.

Parameters:

globalId - a global ID

tenantId - the required tenant ID

Returns:

the corresponding work object ID

Throws:

EntityNotFoundException - if there is no match

getWorkObjectIdForExternalId

String getWorkObjectIdForExternalId(String externalId)

Returns the work object ID corresponding to the given external ID.

Parameters:

externalId - an external ID (may be null)

Returns:

the corresponding work object ID (or null if the input is null)

getExternalIdForWorkObjectId

String getExternalIdForWorkObjectId(String workObjectId)

Returns the external ID corresponding to the given work object ID.

Parameters:

workObjectId - an work object ID

Returns:

the corresponding external ID

Throws:

EntityNotFoundException - if there is no match

getDefinitionIdForExternalId

String getDefinitionIdForExternalId(String externalId)

Returns the work object definition ID corresponding to the given external ID.

Parameters:

externalId - an external ID

Returns:

the corresponding work object definition ID

getExternalIdForDefinitionId

String getExternalIdForDefinitionId(String definitionId)

Returns the external definition ID corresponding to the given work object ID.

Parameters:

definitionId - a definition ID

Returns:

the corresponding external definition ID

Throws:

EntityNotFoundException - if there is no match