com.softwareag.centrasite.api.csom.search
Interface CSOSearchScope


public interface CSOSearchScope

The CSOSearchScope determines which objects are affected by the search. The default configuration defines the following pre-configured scopes:

  • Assets - Includes all top level asset types
  • Everything - Includes top level types and searchable types, but not currently LCMs or Policies
  • Users - Includes all CSO user objects representing registered users.
  • Organizations - Includes all CSO organization objects


    Field Summary
    static java.lang.String Assets
               
    static java.lang.String Everything
               
    static java.lang.String Organizations
               
    static java.lang.String Users
               
     
    Method Summary
     java.util.Collection<CentraSiteObjectAttribute> getAttribute(java.lang.String schemaName)
              Returns the CSOAttributes based on their (schema) name.
     java.util.Collection<CentraSiteObjectAttribute> getAttributes()
              Returns the Collection of CSOAttributes for the current scope.
     java.lang.String getDisplayName()
              Retrieves the dsiplay name of the scope according to the user locale.
     java.lang.String getDisplayName(java.util.Locale locale)
              Retrieves the display name of the type according to the given locale.
     java.util.Collection<Category> getExcludedCategories()
              Returns a collection of categories that are excluded from the search scope.
     java.util.Collection<Category> getIncludedCategories()
              Returns a collection of categories that are included in the search scope.
     java.lang.String getName()
              Retrieves the name of the scope.
     java.util.Collection<CentraSiteRegistryObjectType> getTypes()
              Returns the asset types which is attached with the search scope Inbox/Everything search scopes will have more than one types
     boolean isExpandable()
              Returns whether this scope is expandable or not.
     void setExcludedCategories(java.util.Collection<Category> categories)
              Sets the collection of categories which need to be excluded the search scope.
     void setIncludedCategories(java.util.Collection<Category> categories)
              Sets the collection of categories which need to be included in the search scope.
     

    Field Detail

    Users

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

    Organizations

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

    Assets

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

    Everything

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

    getName

    java.lang.String getName()
    Retrieves the name of the scope.

    Returns:
    name of the search scope

    getDisplayName

    java.lang.String getDisplayName()
                                    throws CLLException
    Retrieves the dsiplay name of the scope according to the user locale.

    Returns:
    display name of the search scope based on current user locale
    Throws:
    CLLException

    getDisplayName

    java.lang.String getDisplayName(java.util.Locale locale)
    Retrieves the display name of the type according to the given locale.

    Parameters:
    locale - Locale for which the name has to be fetched
    Returns:
    display name based on the given locale

    isExpandable

    boolean isExpandable()
    Returns whether this scope is expandable or not. Decided by configurator.

    Returns:
    true if the scope is expandable, false otherwise.

    getTypes

    java.util.Collection<CentraSiteRegistryObjectType> getTypes()
    Returns the asset types which is attached with the search scope Inbox/Everything search scopes will have more than one types

    Returns:
    list of asset types attached with the scope

    getAttribute

    java.util.Collection<CentraSiteObjectAttribute> getAttribute(java.lang.String schemaName)
    Returns the CSOAttributes based on their (schema) name.

    Parameters:
    schemaName - name that identifies a attribute in the current search scope
    Returns:
    CentraSiteObjectAttribute for the given schemaName

    getIncludedCategories

    java.util.Collection<Category> getIncludedCategories()
    Returns a collection of categories that are included in the search scope.
    This will mean that the objects that are classified with the categories will be added to the search scope. The included categories are generally "OR"ed when performing search

    Returns:
    Collection of included categories in the search scope

    getExcludedCategories

    java.util.Collection<Category> getExcludedCategories()
    Returns a collection of categories that are excluded from the search scope.
    This will mean that the objects that are classified with the categories will be removed from the search scope. The excluded categories are generally "AND"ed when performing search

    Returns:
    Collection of included categories in the search scope

    setExcludedCategories

    void setExcludedCategories(java.util.Collection<Category> categories)
    Sets the collection of categories which need to be excluded the search scope.

    Parameters:
    categories - - Collection of categories

    setIncludedCategories

    void setIncludedCategories(java.util.Collection<Category> categories)
    Sets the collection of categories which need to be included in the search scope.

    Parameters:
    categories - - Collection of categories

    getAttributes

    java.util.Collection<CentraSiteObjectAttribute> getAttributes()
    Returns the Collection of CSOAttributes for the current scope.

    Returns:
    CentraSiteObjectAttribute for the given schemaName