com.ibm.pim.interfaces.managers
Interface UserDefinedLogManager

All Superinterfaces:
Manager

public interface UserDefinedLogManager
extends Manager

Read-write interface for the Manager of UserDefinedLog objects


Field Summary
static java.lang.String copyright
           
 
Method Summary
 UserDefinedLog createUserDefinedLog(Catalog catalog, java.lang.String name, boolean runningLog)
          Creates a UserDefined Log based upon an owning Catalog Retrieve a UserDefinedLog based upon the owning catalog and log name
 UserDefinedLog createUserDefinedLog(Hierarchy hierarchy, java.lang.String name, boolean runningLog)
          Creates a UserDefined Log based upon an owning Hierarchy Retrieve a UserDefinedLog based upon the owning hierarchy and log name
 UserDefinedLog getUserDefinedLogByName(Catalog catalog, java.lang.String name)
          Retrieves a specific UserDefinedLog in a specified catalog with a specified name
 UserDefinedLog getUserDefinedLogByName(Hierarchy hierarchy, java.lang.String name)
          Retrieves a specific UserDefinedLog in a specified hierarchy with a specified name
 PIMCollection getUserDefinedLogs()
          Retrieves all UserDefinedLogs available in the current context
 java.util.Collection getUserDefinedLogs(Catalog catalog)
          Retrieves all UserDefinedLogs available in the current context for the specified Catalog
 java.util.Collection getUserDefinedLogs(Hierarchy hierarchy)
          Retrieves all UserDefinedLogs available in the current context for the specified Hierarchy
 
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

createUserDefinedLog

public UserDefinedLog createUserDefinedLog(Catalog catalog,
                                           java.lang.String name,
                                           boolean runningLog)
                                    throws PIMInternalException,
                                           PIMAuthorizationException
Creates a UserDefined Log based upon an owning Catalog Retrieve a UserDefinedLog based upon the owning catalog and log name

Parameters:
catalog - - The Catalog
name - - The log name
runningLog - - boolean. true if log is running false if not
Returns:
UserDefinedLog
Throws:
PIMInternalException
PIMAuthorizationException
See Also:
Catalog, UserDefinedLog

createUserDefinedLog

public UserDefinedLog createUserDefinedLog(Hierarchy hierarchy,
                                           java.lang.String name,
                                           boolean runningLog)
                                    throws PIMInternalException,
                                           PIMAuthorizationException
Creates a UserDefined Log based upon an owning Hierarchy Retrieve a UserDefinedLog based upon the owning hierarchy and log name

Parameters:
name - - The log name
runningLog - - boolean. true if log is running false if not
Returns:
UserDefinedLog
Throws:
PIMInternalException
PIMAuthorizationException
See Also:
Hierarchy, UserDefinedLog

getUserDefinedLogs

public PIMCollection getUserDefinedLogs()
                                 throws PIMInternalException,
                                        PIMAuthorizationException
Retrieves all UserDefinedLogs available in the current context

Returns:
A PIMCollection of UserDefinedLogs. 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, UserDefinedLog

getUserDefinedLogs

public java.util.Collection getUserDefinedLogs(Catalog catalog)
                                        throws PIMInternalException,
                                               PIMAuthorizationException
Retrieves all UserDefinedLogs available in the current context for the specified Catalog

Parameters:
catalog - the catalog for which to retrieve logs
Returns:
A PIMCollection of UserDefinedLogs. 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, UserDefinedLog

getUserDefinedLogs

public java.util.Collection getUserDefinedLogs(Hierarchy hierarchy)
                                        throws PIMInternalException,
                                               PIMAuthorizationException
Retrieves all UserDefinedLogs available in the current context for the specified Hierarchy

Parameters:
hierarchy - the hierarchy for which to retrieve logs
Returns:
A PIMCollection of UserDefinedLogs. 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, UserDefinedLog

getUserDefinedLogByName

public UserDefinedLog getUserDefinedLogByName(Catalog catalog,
                                              java.lang.String name)
                                       throws PIMInternalException,
                                              PIMAuthorizationException
Retrieves a specific UserDefinedLog in a specified catalog with a specified name

Parameters:
catalog - The Catalog for which to retrieve the UserDefinedLog
name - The name of the UserDefinedLog 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:
Catalog

getUserDefinedLogByName

public UserDefinedLog getUserDefinedLogByName(Hierarchy hierarchy,
                                              java.lang.String name)
                                       throws PIMInternalException,
                                              PIMAuthorizationException
Retrieves a specific UserDefinedLog in a specified hierarchy with a specified name

Parameters:
hierarchy - The Hierarchy for which to retrieve the UserDefinedLog
name - The name of the UserDefinedLog 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:
Hierarchy