com.ibm.pim.spec
Interface SpecMap


public interface SpecMap

Interface for SpecMap

Since:
6.0.0

Nested Class Summary
static class SpecMap.Type
          Possible SpecMap types
 
Field Summary
static java.lang.String copyright
           
 
Method Summary
 SpecMapEntry addMapping(AttributeDefinition sourceAttributeDefinition, AttributeDefinition destinationAttributeDefinition)
          Adds a mapping between sourceAttributeDefinition and destinationAttributeDefinition in to the specMap The newly added mapping must be persisted by calling save() on the containing specMap
 void delete()
          Delete a specMap
 java.lang.String getDestinationObjectName()
          Returns the name of the destination object in the specMap
 java.util.Collection<SpecMapEntry> getEntries()
          Return the mappings between source AttributeDefinitions and destination AttributeDefinitions in the specMap.
 java.lang.String getName()
          Returns the name of the SpecMap
 java.lang.String getSourceObjectName()
          Returns the name of the source object in the specMap
 SpecMap.Type getType()
          Returns the type of the specMap
 void save()
          Save a specMap
 

Field Detail

copyright

static final java.lang.String copyright
See Also:
Constant Field Values
Method Detail

getName

java.lang.String getName()
Returns the name of the SpecMap

Returns:
String SpecMap name

delete

void delete()
Delete a specMap

Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user does not have the equivalent of SystemWideAccessPrivilege.SPEC_MODIFY_SPEC_MAP

save

void save()
Save a specMap

Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user does not have the equivalent of SystemWideAccessPrivilege.SPEC_MODIFY_SPEC_MAP

getType

SpecMap.Type getType()
Returns the type of the specMap

Returns:
the spec map type
Throws:
PIMInternalException - If an internal error occurs

getSourceObjectName

java.lang.String getSourceObjectName()
Returns the name of the source object in the specMap

Returns:
source object name
Throws:
PIMInternalException - If an internal error occurs

getDestinationObjectName

java.lang.String getDestinationObjectName()
Returns the name of the destination object in the specMap

Returns:
destination object name
Throws:
PIMInternalException - If an internal error occurs

addMapping

SpecMapEntry addMapping(AttributeDefinition sourceAttributeDefinition,
                        AttributeDefinition destinationAttributeDefinition)
Adds a mapping between sourceAttributeDefinition and destinationAttributeDefinition in to the specMap The newly added mapping must be persisted by calling save() on the containing specMap

Parameters:
sourceAttributeDefinition - Source AttributeDefinition in a mapping which belongs to this specMap
destinationAttributeDefinition - Destination AttributeDefinition in a mapping which belongs to this specMap
Returns:
a SpecMapEntry
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use
java.lang.IllegalArgumentException - If the sourceAttributeDefinition or destinationAttributeDefinition passed in is null or the sourceAttributeDefinition or destinationAttributeDefinition passed is not related to the source object or destination object respectively
java.lang.IllegalStateException - If the sourceAttributeDefinition or destinationAttributeDefinition has not been persisted

getEntries

java.util.Collection<SpecMapEntry> getEntries()
Return the mappings between source AttributeDefinitions and destination AttributeDefinitions in the specMap.

Returns:
a collection of SpecMapEntry
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use