Package com.redwood.scheduler.api.model

Interface SoftwareGroup

All Superinterfaces:

BusinessKeyObject, NamedRootObject, NamedRootObjectComp, Root, SchedulerEntity, SchedulerEntityComp, SoftwareGroupComp

public interface SoftwareGroup
extends SoftwareGroupComp, NamedRootObject, BusinessKeyObject

Files are grouped, making this a placeholder object.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "SoftwareGroup" objects.
static String	SEC_RANK_ALL	This rank is made of the following privileges:
static String	SEC_RANK_NONE	This rank has no privileges assigned to it.
static QueryObjectType<SoftwareGroup>	TYPE	Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).

Fields inherited from interface com.redwood.scheduler.api.model.SchedulerEntity

ACTION_AUDIT, ACTION_EXPORT, ACTION_READ, BEHAVIOR_DEPRECATED, BEHAVIOR_NONE, BEHAVIOR_SYSTEM

Method Summary

Modifier and Type	Method	Description
SoftwareItem	createSoftwareItem()	Create a new SoftwareItem linked to this object.
LicensableItem	getRequiredLicense()	Get the value for RequiredLicense.
RWIterable<SoftwareItem>	getSoftwareItems()	Get an RWIterable over a collection of SoftwareItems, the collection will be ordered by Name.

Methods inherited from interface com.redwood.scheduler.api.model.BusinessKeyObject

getBusinessKey

Methods inherited from interface com.redwood.scheduler.api.model.NamedRootObject

createObjectReference, getComment, getDescription, getLinkedObjectReferenceByLinkedObject, getLinkedObjectReferenceByName, getLinkedObjectReferences, getName, getSearchName, getSourceObjectReferences, isHidden, setComment, setDescription, setName

Methods inherited from interface com.redwood.scheduler.api.model.Root

getCreationTime, getLastModificationTime, getLastModifierSubject

Methods inherited from interface com.redwood.scheduler.api.model.SchedulerEntity

canPerform, createSubjectObjectPrivilegeGrant, deleteObject, getAuditTrail, getAuditTrailSize, getBehavior, getEffectiveBehavior, getErrorNameEN, getErrorNameKey, getLLPVersion, getLOV, getLOVSupport, getObjectType, getParentSchedulerEntities, getRuntime, getSubjectObjectPrivilegeGrantBySubject, getSubjectObjectPrivilegeGrants, getUniqueId, getUrl, getUrl, isCreated, isDeletable, isDeleted, isModifiable, isModified, isSelectVersioned, processRelatedObjects, processRelatedObjects, processRelatedObjects, refreshObject, resetObject, resetObject, resetValuesToDefault, selectForRead

Field Detail

OBJECT_TYPE

static final String OBJECT_TYPE

String that will be returned from SchedulerEntity.getObjectType() for "SoftwareGroup" objects.

See Also:

Constant Field Values

TYPE

static final QueryObjectType<SoftwareGroup> TYPE

Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).

SEC_RANK_NONE

static final String SEC_RANK_NONE

This rank has no privileges assigned to it.

See Also:

Constant Field Values

SEC_RANK_ALL

static final String SEC_RANK_ALL

This rank is made of the following privileges:

See Also:

Constant Field Values

Method Detail

getRequiredLicense

LicensableItem getRequiredLicense()

Get the value for RequiredLicense. (The license key required to view this group, null means that this group can always be viewed)

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.

getSoftwareItems

RWIterable<SoftwareItem> getSoftwareItems()

Get an RWIterable over a collection of SoftwareItems, the collection will be ordered by Name. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Files are grouped.

Specified by:

getSoftwareItems in interface SoftwareGroupComp

Returns:

An RWIterable over a collection of SoftwareItem objects , the collection will be ordered by Name.

createSoftwareItem

SoftwareItem createSoftwareItem()

Create a new SoftwareItem linked to this object.

Returns:

a new SoftwareItem.