|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SpecMap
Interface for SpecMap
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 |
---|
static final java.lang.String copyright
Method Detail |
---|
java.lang.String getName()
void delete()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
SystemWideAccessPrivilege.SPEC_MODIFY_SPEC_MAP
void save()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
SystemWideAccessPrivilege.SPEC_MODIFY_SPEC_MAP
SpecMap.Type getType()
PIMInternalException
- If an internal error occursjava.lang.String getSourceObjectName()
PIMInternalException
- If an internal error occursjava.lang.String getDestinationObjectName()
PIMInternalException
- If an internal error occursSpecMapEntry addMapping(AttributeDefinition sourceAttributeDefinition, AttributeDefinition destinationAttributeDefinition)
save()
on the containing specMap
sourceAttributeDefinition
- Source AttributeDefinition in a mapping which belongs to this specMapdestinationAttributeDefinition
- Destination AttributeDefinition in a mapping which belongs to this specMap
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 persistedjava.util.Collection<SpecMapEntry> getEntries()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |