com.ibm.pim.interfaces.spec
Interface Spec

All Known Subinterfaces:
DestinationSpec, FileSpec, LookupSpec, PrimarySpec, SecondarySpec, SubSpec

public interface Spec

Read-only interface for the generic Spec object


Field Summary
static java.lang.String copyright
           
static int FILE_SPEC
           
static int LKP_SPEC
           
static int MKT_SPEC
           
static int PRIMARY_SPEC
           
static int SCRIPT_INPUT_SPEC
           
static int SECONDARY_SPEC
           
static int SUB_SPEC
           
 
Method Summary
 java.lang.String getDisplayName()
          Returns the Spec Name
 java.util.Collection getLocales()
          Returns all associated Locales if this Spec is localized
 SpecNode getSpecNodeByPath(java.lang.String path)
          Return a specific SpecNode for this Spec, by path
 java.util.Collection getSpecNodes()
          Returns all SpecNodes for this Spec
 boolean isLocalized()
          Identify whether this Spec is localized
 

Field Detail

copyright

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

FILE_SPEC

public static final int FILE_SPEC
See Also:
Constant Field Values

PRIMARY_SPEC

public static final int PRIMARY_SPEC
See Also:
Constant Field Values

SECONDARY_SPEC

public static final int SECONDARY_SPEC
See Also:
Constant Field Values

MKT_SPEC

public static final int MKT_SPEC
See Also:
Constant Field Values

LKP_SPEC

public static final int LKP_SPEC
See Also:
Constant Field Values

SCRIPT_INPUT_SPEC

public static final int SCRIPT_INPUT_SPEC
See Also:
Constant Field Values

SUB_SPEC

public static final int SUB_SPEC
See Also:
Constant Field Values
Method Detail

getDisplayName

public java.lang.String getDisplayName()
                                throws PIMInternalException,
                                       PIMAuthorizationException
Returns the Spec Name

Returns:
The name of this Spec
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user is not allowed to perform this operation

getSpecNodes

public java.util.Collection getSpecNodes()
                                  throws PIMInternalException,
                                         PIMAuthorizationException
Returns all SpecNodes for this Spec

Returns:
a java.util.Collection of SpecNode objects
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user is not allowed to perform this operation

getSpecNodeByPath

public SpecNode getSpecNodeByPath(java.lang.String path)
                           throws PIMInternalException,
                                  PIMAuthorizationException
Return a specific SpecNode for this Spec, by path

Parameters:
path - Complete node path in the format /
Returns:
A SpecNode object, or null if no match.
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user is not allowed to perform this operation

isLocalized

public boolean isLocalized()
                    throws PIMInternalException,
                           PIMAuthorizationException
Identify whether this Spec is localized

Returns:
true if this Spec is localized.
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user is not allowed to perform this operation

getLocales

public java.util.Collection getLocales()
                                throws PIMInternalException,
                                       PIMAuthorizationException
Returns all associated Locales if this Spec is localized

Returns:
a java.util.Collection of Locale objects, or null if not Localized
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user is not allowed to perform this operation