ibi.broker.api.data.library
Class Content

java.lang.Object
  ibi.broker.api.data.content.ContentObject
      ibi.broker.api.data.library.Content

All Implemented Interfaces:

java.io.Serializable

public class Content
extends ibi.broker.api.data.content.ContentObject
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

static java.lang.String	ACCESS_TYPE_LIST String constant representing one of the three valid access options.
static java.lang.String	ACCESS_TYPE_OWNER String constant representing one of the three valid access options.
static java.lang.String	ACCESS_TYPE_PUBLIC String constant representing one of the three valid access options.
static java.lang.String	EXPIREMODE_DAY String constant representing library expiration based upon the number of days.
static java.lang.String	EXPIREMODE_HOUR This expiration mode is for future use and is not currently implemented.
static java.lang.String	EXPIREMODE_MONTH String constant representing a library expiration based upon a number of months.
static java.lang.String	EXPIREMODE_NEVER String constant representing expiration mode of NEVER.
static java.lang.String	EXPIREMODE_VERSION String constant representing a "version" type of library expiration.
static java.lang.String	EXPIREMODE_WEEK String constant representing a library expiration based upon a number of weeks.
static java.lang.String	EXPIREMODE_YEAR String constant representing a library expiration based upon a number of years.

Fields inherited from class ibi.broker.api.data.content.ContentObject

id

Constructor Summary

Content()

Method Summary

java.lang.String	getAccessList() Obtains the name of the Access List, which is a list of users that have access to this content in the report library.
java.lang.String	getAccessType() Obtains one of the three access options (i.e., "access types") as a String constant.
java.lang.String	getBurstValue() Obtains the burst value associated with this library report distribution.
Category	getCategory()
java.lang.String	getDescription() Obtains a string describing this scheduled distribution of report library content.
int	getExpireInterval() Obtains the expiration interval of report content distributed to the report library.
java.lang.String	getExpireMode() Obtains the expiration mode for the report library content.
java.util.Calendar	getLastExecTime()
int	getLastVersion()
java.lang.String	getOwner() Obtains the owner of this scheduled distribution of content to the Report Library.
java.lang.String	getScheduleId()
java.lang.String	getTaskId()
Version[]	getVersionList() /** Obtains an Array of Version objects that contains the report output from the ReportCaster schedule that is associated with this Content object.
WatchItem[]	getWatchItemList()
boolean	isWatch()
void	setAccessList(java.lang.String accessList) Assigns the name of the Access List, which is a list of users that have access to this content in the report library.
void	setAccessType(java.lang.String accessType) Assigns one of the three access options (i.e., "access types") as a String Constant.
void	setBurstValue(java.lang.String burstValue) Assigns the burst value associated with this library report distribution.
void	setCategory(Category parent)
void	setDescription(java.lang.String description) Assigns a string describing this scheduled distribution of report library content.
void	setExpireInterval(int expireInterval) Assigns the expiration interval to a report content distributed to the report library.
void	setExpireMode(java.lang.String expireMode) Assigns the expiration mode for the report library content.
void	setLastExecTime(java.util.Calendar lastExecTime)
void	setLastVersion(int lastVersion)
void	setOwner(java.lang.String owner) Assigns an owner to this scheduled distribution of content to the Report Library.
void	setScheduleId(java.lang.String scheduleId)
void	setTaskId(java.lang.String taskId)
void	setVersionList(Version[] versionList) Assigns an Array of Version objects that contains the report output from the ReportCaster schedule that is associated with this Content object.
void	setWatch(boolean isWatch)
void	setWatchItemList(WatchItem[] watchItemList)
void	validate(java.lang.String parentName) Assists in validating arguments

Methods inherited from class ibi.broker.api.data.content.ContentObject

equals, getId, hashCode, setId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

EXPIREMODE_VERSION

public static final java.lang.String EXPIREMODE_VERSION

String constant representing a "version" type of library expiration. There are three types of library expiration based on: a length of time, a number of versions, and never expire.

See Also:

setExpireMode(String expireMode), Constant Field Values

EXPIREMODE_HOUR

public static final java.lang.String EXPIREMODE_HOUR

This expiration mode is for future use and is not currently implemented.

See Also:

Constant Field Values

EXPIREMODE_NEVER

public static final java.lang.String EXPIREMODE_NEVER

String constant representing expiration mode of NEVER. There are three content expiration groupings: based on a length of time, based on a number of versions, and never expire.

See Also:

setExpireMode(String expireMode), Constant Field Values

EXPIREMODE_DAY

public static final java.lang.String EXPIREMODE_DAY

String constant representing library expiration based upon the number of days. There are three types of library expiration based on: a length of time, a number of versions, and never expire.

See Also:

setExpireMode(String expireMode), Constant Field Values

EXPIREMODE_WEEK

public static final java.lang.String EXPIREMODE_WEEK

String constant representing a library expiration based upon a number of weeks. There are three types of library expiration based on: a length of time, a number of versions, and never expire.

See Also:

setExpireMode(String expireMode), Constant Field Values

EXPIREMODE_MONTH

public static final java.lang.String EXPIREMODE_MONTH

String constant representing a library expiration based upon a number of months. There are three types of library expiration based on: a length of time, a number of versions, and never expire.

See Also:

setExpireMode(String expireMode), Constant Field Values

EXPIREMODE_YEAR

public static final java.lang.String EXPIREMODE_YEAR

String constant representing a library expiration based upon a number of years. There are three types of library expiration based on: a length of time, a number of versions, and never expire.

See Also:

setExpireMode(String expireMode), Constant Field Values

ACCESS_TYPE_OWNER

public static final java.lang.String ACCESS_TYPE_OWNER

String constant representing one of the three valid access options.

See Also:

setAccessType(String accessType), Constant Field Values

ACCESS_TYPE_PUBLIC

public static final java.lang.String ACCESS_TYPE_PUBLIC

String constant representing one of the three valid access options.

See Also:

setAccessType(String accessType), Constant Field Values

ACCESS_TYPE_LIST

public static final java.lang.String ACCESS_TYPE_LIST

String constant representing one of the three valid access options.

See Also:

setAccessType(String accessType), Constant Field Values

Constructor Detail

Content

public Content()

Method Detail

setDescription

public void setDescription(java.lang.String description)

Assigns a string describing this scheduled distribution of report library content. The maximum size for the description is 90 characters.

Parameters:

description - Reference to the description as String.

See Also:

getDescription()

getDescription

public java.lang.String getDescription()

Obtains a string describing this scheduled distribution of report library content. The maximum size for the description is 90 characters.

Returns:

The description as a String

See Also:

setDescription(String)

getScheduleId

public java.lang.String getScheduleId()

Returns:

Returns the scheduleId.

setScheduleId

public void setScheduleId(java.lang.String scheduleId)

Parameters:

scheduleId - The ID fo the schedule that created this report.

setOwner

public void setOwner(java.lang.String owner)

Assigns an owner to this scheduled distribution of content to the Report Library. The distribution server assumes the Owner is identified with the username of the individual logged into ReportCaster who scheduled the distribution of report library content. The maximum size of the owner string is 48 characters.

Parameters:

owner - The username of schedule owner

See Also:

getOwner()

getOwner

public java.lang.String getOwner()

Obtains the owner of this scheduled distribution of content to the Report Library. The distribution server assumes the Owner is identified with the username of the individual logged into ReportCaster who scheduled the distribution of report library content.

Returns:

The username of the schedule owner as a String

See Also:

setOwner(String)

setBurstValue

public void setBurstValue(java.lang.String burstValue)

Assigns the burst value associated with this library report distribution. ReportCaster's burst feature allows you to break a report up into sections to be distributed separately based on the value of a primary sort field, also known as a burst value. In order to burst a report for distribution to the library or any other destination the Enable Report Bursting flag must be set in the schedule. The maximum size of the burst value is 75 characters.

Parameters:

burstValue - The burst value.

See Also:

getBurstValue()

getBurstValue

public java.lang.String getBurstValue()

Obtains the burst value associated with this library report distribution. ReportCaster's burst feature allows you to break a report up into sections to be distributed separately based on the value of a report's primary sort field, also known as a burst value. In order to burst a report for distribution to the library or any other destination the Enable Report Bursting flag must be set in the schedule. The maximum size of the burst value is 75 characters.

Returns:

The burst value as a String

See Also:

setBurstValue(String)

setExpireMode

public void setExpireMode(java.lang.String expireMode)

Assigns the expiration mode for the report library content. There are three types of expiration modes: based on a length of time, on a number of versions, and never expire. The constant values are: EXPIREMODE_VERSION, EXPIREMODE_NEVER, EXPIREMODE_DAY, EXPIREMODE_WEEK, EXPIREMODE_MONTH, EXPIREMODE_YEAR

Parameters:

expireMode - String constant representing the expiration mode

See Also:

getExpireMode()

getExpireMode

public java.lang.String getExpireMode()

Obtains the expiration mode for the report library content. There are three types of expiration modes based on: a length of time, on a number of versions, and never expire. The constant values are: EXPIREMODE_VERSION, EXPIREMODE_NEVER, EXPIREMODE_DAY, EXPIREMODE_WEEK, EXPIREMODE_MONTH, EXPIREMODE_YEAR.

Returns:

The expiration mode as a String constant

See Also:

setExpireMode(String)

setExpireInterval

public void setExpireInterval(int expireInterval)

Assigns the expiration interval to a report content distributed to the report library. The expiration interval is an integer that is coupled with the expiration mode. For examplet, if he expiration mode is set for EXPIREMODE_DAY. An expiration interval of 15 would mean that the report in the report library will expire in 15 days.

Parameters:

expireInterval - The expiration interval as an integer.

See Also:

getExpireInterval()

getExpireInterval

public int getExpireInterval()

Obtains the expiration interval of report content distributed to the report library. The expiration interval is an integer that is coupled with the expiration mode. For example, if the expiration mode is set for EXPIREMODE_DAY. An expiration interval of 15 would mean that the report in the report library will expire in 15 days.

Returns:

The expiration interval as an integer

See Also:

setExpireInterval(int)

setVersionList

public void setVersionList(Version[] versionList)

Assigns an Array of Version objects that contains the report output from the ReportCaster schedule that is associated with this Content object. Each Content class reprsents a ReportCaster schedule that is distributed to the library. The actual reports produced by the schedule are contained in an array of Version objects, with each member of the Version array representing the output of a single scheduled distribution.

Parameters:

versionList - Reference to the array of version objects.

See Also:

getVersionList()

getVersionList

public Version[] getVersionList()

/** Obtains an Array of Version objects that contains the report output from the ReportCaster schedule that is associated with this Content object. Each Content class reprsents a ReportCaster schedule that is distributed to the library. The actual reports produced by the schedule are contained in an array of Version objects, with each member of the Version array representing the output of a single scheduled distribution.

Returns:

An array of version objects

See Also:

setVersionList(Version[])

getAccessList

public java.lang.String getAccessList()

Obtains the name of the Access List, which is a list of users that have access to this content in the report library. Access to the library content via an access list is one of the three available access options (i.e., access types) and is formally represented by the string constant: ACCESS_TYPE_LIST when the schedule is created. The other two options are ACCESS_TYPE_PUBLIC and ACCESS_TYPE_OWNER, which represent public access and owner access respectively. In order for their to be a value for this field, an access list must have been designated during scheduling, or assigned subsequently via setAccessList(). The maximum size of an Access List is 64 characters.

Returns:

The name of the access list as a String

See Also:

setAccessList(String), getAccessType(), setAccessType(String)

getAccessType

public java.lang.String getAccessType()

Obtains one of the three access options (i.e., "access types") as a String constant. The available choices include: ACCESS_TYPE_LIST (access via access list), ACCESS_TYPE_PUBLIC (public access) and ACCESS_TYPE_OWNER (access by owner). See constant definitions in field summary table above.

Returns:

The access type as a String

See Also:

setAccessType(String)

setAccessList

public void setAccessList(java.lang.String accessList)

Assigns the name of the Access List, which is a list of users that have access to this content in the report library. Access to the library content via an access list is one of the three available access options (i.e., "access types") and is formally represented by the string constant: ACCESS_TYPE_LIST when the schedule is created. The other two options are ACCESS_TYPE_PUBLIC and ACCESS_TYPE_OWNER, which represent public access and owner access respectively. The maximum size of an Access List is 64 characters.

Parameters:

accessList - Name of the access list

See Also:

getAccessList(), getAccessType(), setAccessType(String)

setAccessType

public void setAccessType(java.lang.String accessType)

Assigns one of the three access options (i.e., "access types") as a String Constant. The available choices include: ACCESS_TYPE_LIST (access via access list), ACCESS_TYPE_PUBLIC (public access) and ACCESS_TYPE_OWNER (access by owner). See constant definitions in field summary table above.

Parameters:

accessType - The access type String constant

See Also:

getAccessType()

getLastVersion

public int getLastVersion()

setLastVersion

public void setLastVersion(int lastVersion)

getLastExecTime

public java.util.Calendar getLastExecTime()

setLastExecTime

public void setLastExecTime(java.util.Calendar lastExecTime)

isWatch

public boolean isWatch()

setWatch

public void setWatch(boolean isWatch)

getTaskId

public java.lang.String getTaskId()

setTaskId

public void setTaskId(java.lang.String taskId)

getCategory

public Category getCategory()

setCategory

public void setCategory(Category parent)

getWatchItemList

public WatchItem[] getWatchItemList()

setWatchItemList

public void setWatchItemList(WatchItem[] watchItemList)

validate

public void validate(java.lang.String parentName)
              throws CasterException

Assists in validating arguments

Parameters:

parentName - represented parent of this object.

Throws:

CasterException