com.ibm.pim.interfaces.managers
Interface SpecManager

All Superinterfaces:
Manager

public interface SpecManager
extends Manager

Read-only interface for the Manager of Spec objects


Field Summary
static java.lang.String copyright
           
 
Method Summary
 Spec getSpecByName(java.lang.String specName)
          Retrieves a specific Spec by name
 PIMCollection getSpecs()
          Retrieves all Specs available in the current context
 PIMCollection getSpecsByType(int type)
          Retrieves all Specs available of the specified type in the current context
 
Methods inherited from interface com.ibm.pim.interfaces.managers.Manager
getManagerName
 

Field Detail

copyright

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

getSpecs

public PIMCollection getSpecs()
                       throws PIMInternalException,
                              PIMAuthorizationException
Retrieves all Specs available in the current context

Returns:
A PIMCollection of Specs. Please note this is a lazily instantiated collection
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user is not allowed to perform this operation
See Also:
for more info, Spec

getSpecByName

public Spec getSpecByName(java.lang.String specName)
                   throws PIMInternalException,
                          PIMAuthorizationException
Retrieves a specific Spec by name

Parameters:
specName - The name of the Spec to be retrieved
Returns:
The Catalog matching that name, or null if no matches found.
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user is not allowed to perform this operation
See Also:
Spec

getSpecsByType

public PIMCollection getSpecsByType(int type)
                             throws PIMInternalException,
                                    PIMAuthorizationException
Retrieves all Specs available of the specified type in the current context

Parameters:
type - one of the spec type constants specified in Spec (Primary,Secondary,Lookup,File,Destination,Script input)
Returns:
A PIMCollection of Specs. Please note this is a lazily instantiated collection
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user is not allowed to perform this operation
See Also:
for more info