Package com.redwood.scheduler.api.model

Interface JARFile

All Superinterfaces:

BusinessKeyObject, Detail, NamedDetailObject, Readable, SchedulerEntity, SchedulerEntityComp

public interface JARFile
extends NamedDetailObject, BusinessKeyObject, Readable

The JAR file

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "JARFile" 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<JARFile>	TYPE	Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).

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

COPYRIGHT_MESSAGE_BKO, ID_BKO

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

COPYRIGHT_MESSAGE_E, ID_E

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.
InputStream	getInputStream()	Get the JAR File data as an InputStream.
Library	getLibrary()	Get the Library.
void	setData(String newData)	Set the value for Data.
void	writeData(InputStream inputStream)	Write to data from the stream to the JARFile.

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

See Also:

Constant Field Values

TYPE

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

getData

String getData()

Get the value for Data. (Base64 encoded version of the file.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

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. (Base64 encoded version of the file.) This value is mandatory.

Parameters:

newData - the new value for Data. If this is null, then the object cannot be persisted.

Throws:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getInputStream

InputStream getInputStream()
                    throws IOException

Get the JAR File data as an InputStream.

Returns:

The InputStream of the data.

Throws:

IOException

writeData

void writeData(InputStream inputStream)
        throws IOException

Write to data from the stream to the JARFile.

Parameters:

inputStream - Type of action to retrieve.

Throws:

IOException

getLibrary

Library getLibrary()

Get the Library.

Returns:

Library

Throws:

ObjectDeletedException - If this method is called when the object has been marked for deletion.

ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.