Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## oracle.ifs.fdk.core
Class CoreSortManager

    java.lang.Object
      oracle.ifs.fdk.impl.SortManagerImpl
          oracle.ifs.fdk.core.CoreSortManager

All Implemented Interfaces:
  java.rmi.Remote, SortManager

    public class CoreSortManager

extends SortManagerImpl

Implementation of the sort manager interface. See the documentation for `SortManager`.*

Constructor Summary
`CoreSortManager()` Constructor.
`CoreSortManager(FdkSession session)`

Method Summary
`protected FdkSessionImpl` | `getConnectedSession()` Return the web service session.
`java.lang.String` | `getPrimarySortAttribute(java.lang.String tableName)` Gets the primary sort attribute for the given table.
`boolean` | `getPrimarySortDirection(java.lang.String tableName)` Gets the primary sort direction (true == ascending) for the given table.
`java.lang.String` | `getSecondarySortAttribute(java.lang.String tableName)` Gets the secondary sort attribute for the given table.
`boolean` | `getSecondarySortDirection(java.lang.String tableName)` Gets the secondary sort direction (true == ascending) for the given table.
`protected boolean` | `isWebServiceCall()` Returns `true` if the current call was made from a web services client.
`protected NamedValue[]` | `login(FdkCredential c, NamedValue[] options, AttributeRequest[] userAttributes)` Internal login method used by web services login managers.
`void` | `referenceTypes(TypeReference ref)` Dummy web service method to create a reference to data types used in the web services to insure that they are defined in the WSDL.
`void` | `setSortPreference(NamedValue[] options)` Creates a setting in the current user's user preferences to always sort the given table using the given options.
`Item[]` | `sortAttributeList(long id, NamedValue[] options, AttributeRequest[] attrs)` Given an id of a repos object, constructs an item with an attribute of the given name and sorts the resulting value.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### CoreSortManager

    public CoreSortManager()

  Constructor.

### CoreSortManager

    public CoreSortManager(FdkSession session)

Method Detail

### setSortPreference

    public void setSortPreference(NamedValue[] options)
                           throws FdkException

  Description copied from interface: `SortManager`
  Creates a setting in the current user's user preferences to always sort the given table using the given options. Primary/secondary attribute names must be valid values in Attributes.java and the values returned by those attributes must implement Comparable. If not specified, direction defaults to true (ascending).

  Parameters:
    `options` - The sort options. Valid options are:
    - notation: {Attribute name, Attribute type}
    - {Options.TABLE_NAME, String}
    - {Options.PRIMARY_SORT_ATTRIBUTE, String}
    - {Options.PRIMARY_SORT_DIRECTION, Boolean}
    - {Options.SECONDARY_SORT_ATTRIBUTE, String}
    - {Options.SECONDARY_SORT_DIRECTION, Boolean}
  Throws:
    `FdkException` - if the operation fails.

### getPrimarySortAttribute

    public java.lang.String getPrimarySortAttribute(java.lang.String tableName)
                                             throws FdkException

  Description copied from interface: `SortManager`
  Gets the primary sort attribute for the given table.

  Parameters:
    `tableName` - The table on which to retrieve the attribute.
  Throws:
    `FdkException` - if the operation fails.

### getPrimarySortDirection

    public boolean getPrimarySortDirection(java.lang.String tableName)
                                    throws FdkException

  Description copied from interface: `SortManager`
  Gets the primary sort direction (true == ascending) for the given table.

  Parameters:
    `tableName` - The table on which to retrieve the attribute.
  Throws:
    `FdkException` - if the operation fails.

### getSecondarySortAttribute

    public java.lang.String getSecondarySortAttribute(java.lang.String tableName)
                                               throws FdkException

  Description copied from interface: `SortManager`
  Gets the secondary sort attribute for the given table.

  Parameters:
    `tableName` - The table on which to retrieve the attribute.
  Throws:
    `FdkException` - if the operation fails.

### getSecondarySortDirection

    public boolean getSecondarySortDirection(java.lang.String tableName)
                                      throws FdkException

  Description copied from interface: `SortManager`
  Gets the secondary sort direction (true == ascending) for the given table.

  Parameters:
    `tableName` - The table on which to retrieve the attribute.
  Throws:
    `FdkException` - if the operation fails.

### sortAttributeList

    public Item[] sortAttributeList(long id,
                                    NamedValue[] options,
                                    AttributeRequest[] attrs)
                             throws FdkException

  Description copied from interface: `SortManager`
  Given an id of a repos object, constructs an item with an attribute of the given name and sorts the resulting value.

  Parameters:
    `id` - The id of the repos object.
    `options` - The sort options. Valid options are:
    - notation: {Attribute name, Attribute type}
    - {Attributes.NAME, String}
    - {Options.PRIMARY_SORT_ATTRIBUTE, String}
    - {Options.PRIMARY_SORT_DIRECTION, Boolean}
    - {Options.SECONDARY_SORT_ATTRIBUTE, String}
    - {Options.SECONDARY_SORT_DIRECTION, Boolean}
    If an attribute name is specified with no direction, ascending is the default. Attribute names must be valid attributes in Attributes.java and must return values that implement Comparable.
  Returns:
    a sorted array of Items.
  Throws:
    `FdkException` - if the operation fails.

### isWebServiceCall

    protected final boolean isWebServiceCall()

  Returns `true` if the current call was made from a web services client. This check can be made by any subclasses in order to determine functionality and restrictions based on the originating call. This feature should be used lightly and only where really necessary as this is not an idea way of implementing business logic.

### referenceTypes

    public void referenceTypes(TypeReference ref)

  Dummy web service method to create a reference to data types used in the web services to insure that they are defined in the WSDL.

### login

    protected final NamedValue[] login(FdkCredential c,
                                       NamedValue[] options,
                                       AttributeRequest[] userAttributes)
                                throws FdkException

  Internal login method used by web services login managers.

  Throws:
    `FdkException`

### getConnectedSession

    protected final FdkSessionImpl getConnectedSession()
                                                throws FdkException

  Return the web service session. The return value is guaranteed to be non-null and to represent a connected session. If the client is not authenticated an FdkException is thrown.

  Throws:
    `FdkException`

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD