|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SpecManager
Manager for Spec objects
Field Summary | |
---|---|
static java.lang.String |
copyright
|
Method Summary | |
---|---|
FileSpec |
createFileSpec(java.lang.String specName,
FileSpec.FileType fileType)
Create a new file spec, supports setting of file type for FileSpec types. |
Spec |
createSpec(java.lang.String specName,
Spec.Type specType)
Create a new spec |
SpecMap |
createSpecMap(java.lang.String specMapName,
SpecMap.Type specMapType,
java.lang.String sourceObjectName,
java.lang.String destinationObjectName)
Create a new SpecMap |
Spec |
getSpec(java.lang.String specName)
Retrieves a specific Spec by name, returns null if Spec with the given name doesn't exist. |
SpecMap |
getSpecMap(java.lang.String specMapName)
Retrieves a specific SpecMap by name, returns null if SpecMap with the given name doesn't exist |
java.util.Collection<SpecMap> |
getSpecMaps()
Retrieves all SpecMaps available in the current context. |
java.util.Collection<Spec> |
getSpecs()
Retrieves all Specs available in the current context. |
java.util.Collection<Spec> |
getSpecs(Spec.Type type)
Retrieves all Specs available of the specified type in the current context. |
Methods inherited from interface com.ibm.pim.common.Manager |
---|
getManagerName |
Field Detail |
---|
static final java.lang.String copyright
Method Detail |
---|
java.util.Collection<Spec> getSpecs()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future useSpec getSpec(java.lang.String specName)
specName
- The name of the Spec to be retrieved
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- If null or empty specName is passed
PIMAuthorizationException
- Reserver for future usejava.util.Collection<Spec> getSpecs(Spec.Type type)
type
- one of the spec type constants specified in
Spec
(Primary,Secondary,Lookup,File,Destination,Script input)
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- If null Type is passed
PIMAuthorizationException
- Reserved for future useSpec createSpec(java.lang.String specName, Spec.Type specType)
specName
- spec namespecType
- spec type, one of the types defined under
Spec.Type
PIMInternalException
- If an internal error occurs If Spec with the same name
already exist.
java.lang.IllegalArgumentException
- If null or empty specName is passed If null Type is passed
PIMAuthorizationException
- If the user does not have the equivalent of
SystemWideAccessPrivilege.SPEC_MODIFY_SPEC
FileSpec createFileSpec(java.lang.String specName, FileSpec.FileType fileType)
specName
- spec namefileType
- one of the allowed file types
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- If null or empty specName is passed If null FileType is
passed
PIMAuthorizationException
- If the user does not have the equivalent of
SystemWideAccessPrivilege.SPEC_MODIFY_SPEC
SpecMap getSpecMap(java.lang.String specMapName)
specMapName
- The name of the SpecMap to be retrieved
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- If null or empty specMapName is passed
PIMAuthorizationException
- Reserved for future usejava.util.Collection<SpecMap> getSpecMaps()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future useSpecMap createSpecMap(java.lang.String specMapName, SpecMap.Type specMapType, java.lang.String sourceObjectName, java.lang.String destinationObjectName)
specMapName
- specmap namespecMapType
- Sppecmap type, one of the types defined under
SpecMap.Type
sourceObjectName
- Source object name - a Spec or a catalogdestinationObjectName
- Destination object name - a Spec or a catalog
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- If null or empty specMapName is passed If null Type is passed
If null or empty sourceObjectName is passed If null or empty
destinationObjectName is passed
PIMAuthorizationException
- If the user does not have the equivalent of
SystemWideAccessPrivilege.SPEC_MODIFY_SPEC_MAP
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |