Interface ObjectIndex

    • Method Detail

      • getDescription

        String getDescription()
        Get the value for Description. (Optional description)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getName

        String getName()
        Get the value for Name. (The name that can be used to refer to this index (the name of the actual index in the database is prefixed with C_ to ensure the names are unique)) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getSearchName

        String getSearchName()
        Get the value for SearchName. (The name that can be used to refer to this index, in search case.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • isUnique

        boolean isUnique()
        Get the value for Unique. (Flag stating that this index is an unique index, unique indexes can only be declared on custom objects)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setDescription

        void setDescription​(String newDescription)
        Set the value for Description. (Optional description) This value is optional.
        Parameters:
        newDescription - the new value for Description.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setName

        void setName​(String newName)
        Set the value for Name. (The name that can be used to refer to this index (the name of the actual index in the database is prefixed with C_ to ensure the names are unique)) This value is mandatory.
        Parameters:
        newName - the new value for Name. If this is null, then the object cannot be persisted.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setUnique

        void setUnique​(boolean newUnique)
        Set the value for Unique. (Flag stating that this index is an unique index, unique indexes can only be declared on custom objects)
        Parameters:
        newUnique - the new value for Unique.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getObjectDefinition

        ObjectDefinition getObjectDefinition()
        Get the ObjectDefinition.
        Returns:
        ObjectDefinition
        Throws:
        com.redwood.scheduler.api.exception.ObjectDeletedException - If this method is called when the object has been marked for deletion.
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.
      • getObjectIndexColumnByColumnOrder

        ObjectIndexColumn getObjectIndexColumnByColumnOrder​(Long columnOrder)
        Get the ObjectIndexColumn by ObjectIndexColumnOrder.
        Parameters:
        columnOrder -
        Returns:
        the ObjectIndexColumn, or null if it could not be found