com.ibm.pim.spec
Interface SpecManager

All Superinterfaces:
Manager

public interface SpecManager
extends Manager

Manager for Spec objects

Since:
6.0.0

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

copyright

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

getSpecs

java.util.Collection<Spec> getSpecs()
Retrieves all Specs available in the current context. Returns an empty collection if no specs were found.

Returns:
A collection of Specs.
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use

getSpec

Spec getSpec(java.lang.String specName)
Retrieves a specific Spec by name, returns null if Spec with the given name doesn't exist.

Parameters:
specName - The name of the Spec to be retrieved
Returns:
The Spec matching that name, exception if no match found.
Throws:
PIMInternalException - If an internal error occurs
java.lang.IllegalArgumentException - If null or empty specName is passed
PIMAuthorizationException - Reserver for future use

getSpecs

java.util.Collection<Spec> getSpecs(Spec.Type type)
Retrieves all Specs available of the specified type in the current context. Returns an empty collection if no specs are found.

Parameters:
type - one of the spec type constants specified in Spec (Primary,Secondary,Lookup,File,Destination,Script input)
Returns:
A collection of Specs.
Throws:
PIMInternalException - If an internal error occurs
java.lang.IllegalArgumentException - If null Type is passed
PIMAuthorizationException - Reserved for future use

createSpec

Spec createSpec(java.lang.String specName,
                Spec.Type specType)
Create a new spec

Parameters:
specName - spec name
specType - spec type, one of the types defined under Spec.Type
Returns:
a Spec type object
Throws:
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

createFileSpec

FileSpec createFileSpec(java.lang.String specName,
                        FileSpec.FileType fileType)
Create a new file spec, supports setting of file type for FileSpec types. Use this method for creating FileSpecs

Parameters:
specName - spec name
fileType - one of the allowed file types
Returns:
a com.ibm.pim.interfaces.Filespec type object
Throws:
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

getSpecMap

SpecMap getSpecMap(java.lang.String specMapName)
Retrieves a specific SpecMap by name, returns null if SpecMap with the given name doesn't exist

Parameters:
specMapName - The name of the SpecMap to be retrieved
Returns:
The SpecMap matching that name, exception if no match found.
Throws:
PIMInternalException - If an internal error occurs
java.lang.IllegalArgumentException - If null or empty specMapName is passed
PIMAuthorizationException - Reserved for future use

getSpecMaps

java.util.Collection<SpecMap> getSpecMaps()
Retrieves all SpecMaps available in the current context. Returns an empty collection if no specMaps were found.

Returns:
A collection of SpecMaps.
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use

createSpecMap

SpecMap createSpecMap(java.lang.String specMapName,
                      SpecMap.Type specMapType,
                      java.lang.String sourceObjectName,
                      java.lang.String destinationObjectName)
Create a new SpecMap

Parameters:
specMapName - specmap name
specMapType - Sppecmap type, one of the types defined under SpecMap.Type
sourceObjectName - Source object name - a Spec or a catalog
destinationObjectName - Destination object name - a Spec or a catalog
Returns:
a com.ibm.pim.spec.SpecMap type object
Throws:
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