Package com.redwood.scheduler.api.model

Interface SoftwareItem

All Superinterfaces:

BusinessKeyObject, Detail, NamedDetailObject, SchedulerEntity, SchedulerEntityComp

public interface SoftwareItem
extends NamedDetailObject, BusinessKeyObject

Represents a file.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "SoftwareItem" 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<SoftwareItem>	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
String	getData()	Get the value for Data.
byte[]	getDataBytes()	Get the value for DataBytes.
String	getFileName()	Get the value for FileName.
String	getHashSha256()	Get the value for HashSha256.
LicensableItem	getRequiredLicense()	Get the value for RequiredLicense.
Long	getSize()	Get the value for Size.
SoftwareGroup	getSoftwareGroup()	Get the SoftwareGroup.
DateTimeZone	getTime()	Get the value for Time.
String	getVersion()	Get the value for Version.
void	setData(String newData)	Set the value for Data.
void	setSize(Long newSize)	Set the value for Size.

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

getBusinessKey

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

getComment, getDescription, getName, getSearchName, setComment, setDescription, setName

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 "SoftwareItem" objects.

See Also:

Constant Field Values

TYPE

static final QueryObjectType<SoftwareItem> 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

getSize

Long getSize()

Get the value for Size. (The file size.) 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.

getTime

DateTimeZone getTime()

Get the value for Time. (The modification time of the file. Since there is no time zone on a file, the time zone is always set to GMT)

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.

getRequiredLicense

LicensableItem getRequiredLicense()

Get the value for RequiredLicense. (The license key required to view this item, null means that this item 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.

getData

String getData()

Get the value for Data. (The file data.)

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.

getDataBytes

byte[] getDataBytes()

Get the value for DataBytes. (The file data.)

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.

getFileName

String getFileName()

Get the value for FileName. (Name of the file as found in jar or zip file, if different from SoftwareItem's display name.)

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.

getVersion

String getVersion()

Get the value for Version. (Version of the download as found in jar or zip file.)

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.

getHashSha256

String getHashSha256()

Get the value for HashSha256. (SHA256 hash of the download file (without any optional properties).)

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.

setSize

void setSize(Long newSize)

Set the value for Size. (The file size.) This value is mandatory.

Parameters:

newSize - the new value for Size. 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.

setData

void setData(String newData)

Set the value for Data. (The file data.) This value is optional.

Parameters:

newData - the new value for Data.

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.

getSoftwareGroup

SoftwareGroup getSoftwareGroup()

Get the SoftwareGroup.

Returns:

SoftwareGroup

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.