Package com.axemble.vdoc.sdk.interfaces

Interface ICatalog

All Superinterfaces:
IDelegationSupport, IDeletionSupport, IElement, ILocalizationScope, IProtocolSupport, IScopeContainer, ISearchSupport, ISecuritySupport, IUriSupport, Serializable
public interface ICatalog extends IElement, IDeletionSupport, ISecuritySupport, ISearchSupport, IUriSupport, IDelegationSupport, IProtocolSupport, IScopeContainer, ILocalizationScope
This interface is intended to group workflows. It allows to share IProperty, IRole and views between IWorkflowContainer and IWorkflow.
Since:
1.0, 15/04/2008
Author:
vlygeros
See Also:

  • Method Details

    • getName

      String getName()
      Returns:
      The system name of the catalog

    • getLabel

      String getLabel()
      Returns:
      The label of the catalog

    • getLabel

      String getLabel(String language)
      Returns:
      The label of the catalog

    • getDescription

      String getDescription()
      Returns:
      The description of the catalog

    • isConfidential

      boolean isConfidential()
      Checks if the catalog is confidential.
      Returns:
      true if the catalog is confidential, otherwise false.

    • isSystem

      boolean isSystem()
      Indicates if the catalog is system.
      Returns:
      true if the catalog is a system, otherwise false.

    • getConfiguration

      IConfiguration getConfiguration()
      Retrieves the confication of the current catalog
      Returns:
      The IConfiguration object

    • getRole

      @Deprecated IRole getRole(String name)
      Deprecated.
      use getOperatorRole
      Retrieves a specified role object by passing its name.
      Parameters:
      name - The name of the requested role.
      Returns:
      The IRole object

    • getRoles

      @Deprecated Collection<? extends IRole> getRoles()
      Deprecated.
      use getOperatorRoles
      Retrieves all the roles of the catalog
      Returns:
      A collection of IRole objects.

    • getOperatorRole

      IOperatorRole getOperatorRole(String name)
      Retrieves a specified role object by passing its name.
      Parameters:
      name - The name of the requested role.
      Returns:
      The IOperatorRole object

    • getOperatorRoles

      Collection<? extends IOperatorRole> getOperatorRoles()
      Retrieves all the roles of the catalog
      Returns:
      A collection of IOperatorRole objects.

    • getList

      IList getList(String name)
      Retrieves a specified list object by passing its name.
      Parameters:
      name - The name of the requested list.
      Returns:
      The IList object.

    • getLists

      Collection<? extends IList> getLists()
      Retrieves all the lists of the catalog.
      Returns:
      A collection of IList objects.

    • getProperty

      IProperty getProperty(String name)
      Retrieves a specified property by passing its name.
      Parameters:
      name - The name of the requested property.
      Returns:
      the IProperty object.

    • getProperties

      Collection<? extends IProperty> getProperties()
      Retrieves all the properties of the catalog.
      Returns:
      A collection of IProperty objects.

    • getType

      int getType()
      Retrieves the type of the catalog.
      Returns:
      A ICatalog.IType.

    • getProject

      IProject getProject()
      Retrieves the project of the catalog
      Returns:
      A IProject.