com.businessobjects.enterprise.fullclient
Interface FullClient

All Superinterfaces:

InfoObject

public interface FullClient
extends InfoObject

Provides the methods that are necessary to manage a Desktop Intelligence document within the BusinessObjects Enterprise Infrastructure.

Nested Class Summary

static class

FullClient.Factory A class with methods for creating instances of the FullClient type.

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

AnalyticActivities	addNewAnalyticActivities() Internal Use Only.
CorporateCategories	addNewCorporateCategories() Appends and returns a new empty CorporateCategories object to the last element of the array.
CustomProperties	addNewCustomProperties() Appends and returns a new empty CustomProperties object to the last element of the array.
EncyclopediaTopics	addNewEncyclopediaTopics() Internal Use Only.
FileProperties	addNewFileProperties() Appends and returns a new empty FileProperties object to the last element of the array.
FullClientProcessingInfo	addNewFullClientProcessingInfo() Appends and returns a new empty FullClientProcessingInfo object to the last element of the array.
PersonalCategories	addNewPersonalCategories() Appends and returns a new empty PersonalCategories object to the last element of the array.
SchedulingInfo	addNewSchedulingInfo() Appends and returns a new empty SchedulingInfo object to the last element of the array.
AnalyticActivities	getAnalyticActivities() Internal Use Only.
CorporateCategories	getCorporateCategories() Returns the ID set of top-level categories that have been assigned to the object.
CustomProperties	getCustomProperties() Returns the custom properties.
EncyclopediaTopics	getEncyclopediaTopics() Internal Use Only.
FileProperties	getFileProperties() Returns the InfoObject's associated files.
FullClientProcessingInfo	getFullClientProcessingInfo() Returns the document properties.
PersonalCategories	getPersonalCategories() Returns the ID set of top-level personal categories that have been assigned to the object.
java.lang.String	getProcessingProgID() Internal Use Only.
SchedulingInfo	getSchedulingInfo() Returns the scheduling information for the object.
boolean	isSetAnalyticActivities() Internal Use Only.
boolean	isSetCorporateCategories() Checks if the CorporateCategories has been set.
boolean	isSetCustomProperties() Checks if the CustomProperties has been set.
boolean	isSetEncyclopediaTopics() Internal Use Only.
boolean	isSetFileProperties() Checks if the FileProperties has been set.
boolean	isSetFullClientProcessingInfo() Checks if the FullClientProcessingInfo has been set.
boolean	isSetPersonalCategories() Checks if the PersonalCategories has been set.
boolean	isSetProcessingProgID() Internal Use Only.
boolean	isSetSchedulingInfo() Checks if the SchedulingInfo has been set.
void	setAnalyticActivities(AnalyticActivities analyticActivities) Internal Use Only.
void	setCorporateCategories(CorporateCategories corporateCategories) Sets the ID set of top-level categories.
void	setCustomProperties(CustomProperties customProperties) Sets the custom properties.
void	setEncyclopediaTopics(EncyclopediaTopics encyclopediaTopics) Internal Use Only.
void	setFileProperties(FileProperties fileProperties) Sets the InfoObject's associated files.
void	setFullClientProcessingInfo(FullClientProcessingInfo fullClientProcessingInfo) Sets the document properties.
void	setPersonalCategories(PersonalCategories personalCategories) Sets the ID set of top-level personal categories.
void	setProcessingProgID(java.lang.String processingProgID) Internal Use Only.
void	setSchedulingInfo(SchedulingInfo schedulingInfo) Sets the scheduling information for the object.
void	unsetAnalyticActivities() Internal Use Only.
void	unsetCorporateCategories() Deletes or unsets the CorporateCategories element.
void	unsetCustomProperties() Deletes or unsets the CustomProperties element.
void	unsetEncyclopediaTopics() Internal Use Only.
void	unsetFileProperties() Deletes or unsets the FileProperties element.
void	unsetFullClientProcessingInfo() Deletes or unsets the FullClientProcessingInfo element.
void	unsetPersonalCategories() Deletes or unsets the PersonalCategories element.
void	unsetProcessingProgID() Internal Use Only.
void	unsetSchedulingInfo() Deletes or unsets the SchedulingInfo element.
org.apache.xmlbeans.XmlString	xgetProcessingProgID() Internal Use Only.
void	xsetProcessingProgID(org.apache.xmlbeans.XmlString processingProgID) Internal Use Only.

Methods inherited from interface com.businessobjects.enterprise.infoobject.InfoObject

addNewAlerts, addNewMultilingualDescriptions, addNewMultilingualNames, addNewPluginInfo, addNewRolesOnObject, addNewSecurityInfo, addNewSecurityInfo2, addNewSharedDoc, getAlerts, getChildrenObjects, getCreationTime, getCUID, getDescription, getEndTime, getErrorMessage, getGUID, getID, getInstance, getInstanceObject, getIsApplicationObject, getIsComponent, getIsHiddenObject, getIsPluginObject, getIsRecurring, getIsRunnableObject, getIsSendable, getIsSystemObject, getKey, getKeywords, getKind, getLastRunTime, getLastSuccessfulInstanceCUID, getMultilingualDescriptions, getMultilingualNames, getName, getNewJobID, getNextRunTime, getObjectIsContainer, getOwner, getOwnerCUID, getParentCUID, getPluginInfo, getRolesOnObject, getRUID, getSchedulable, getSecurityInfo, getSecurityInfo2, getSharedDoc, getStartTime, getUiStatus, getUpdateTime, isSetAlerts, isSetChildrenObjects, isSetCreationTime, isSetCUID, isSetDescription, isSetEndTime, isSetErrorMessage, isSetGUID, isSetID, isSetInstance, isSetInstanceObject, isSetIsApplicationObject, isSetIsComponent, isSetIsHiddenObject, isSetIsPluginObject, isSetIsRecurring, isSetIsRunnableObject, isSetIsSendable, isSetIsSystemObject, isSetKey, isSetKeywords, isSetKind, isSetLastRunTime, isSetLastSuccessfulInstanceCUID, isSetMultilingualDescriptions, isSetMultilingualNames, isSetNewJobID, isSetNextRunTime, isSetObjectIsContainer, isSetOwner, isSetOwnerCUID, isSetParentCUID, isSetPluginInfo, isSetRolesOnObject, isSetRUID, isSetSchedulable, isSetSecurityInfo, isSetSecurityInfo2, isSetSharedDoc, isSetStartTime, isSetUiStatus, isSetUpdateTime, setAlerts, setChildrenObjects, setCreationTime, setCUID, setDescription, setEndTime, setErrorMessage, setGUID, setID, setInstance, setInstanceObject, setIsApplicationObject, setIsComponent, setIsHiddenObject, setIsPluginObject, setIsRecurring, setIsRunnableObject, setIsSendable, setIsSystemObject, setKey, setKeywords, setKind, setLastRunTime, setLastSuccessfulInstanceCUID, setMultilingualDescriptions, setMultilingualNames, setName, setNewJobID, setNextRunTime, setObjectIsContainer, setOwner, setOwnerCUID, setParentCUID, setPluginInfo, setRolesOnObject, setRUID, setSchedulable, setSecurityInfo, setSecurityInfo2, setSharedDoc, setStartTime, setUiStatus, setUpdateTime, unsetAlerts, unsetChildrenObjects, unsetCreationTime, unsetCUID, unsetDescription, unsetEndTime, unsetErrorMessage, unsetGUID, unsetID, unsetInstance, unsetInstanceObject, unsetIsApplicationObject, unsetIsComponent, unsetIsHiddenObject, unsetIsPluginObject, unsetIsRecurring, unsetIsRunnableObject, unsetIsSendable, unsetIsSystemObject, unsetKey, unsetKeywords, unsetKind, unsetLastRunTime, unsetLastSuccessfulInstanceCUID, unsetMultilingualDescriptions, unsetMultilingualNames, unsetNewJobID, unsetNextRunTime, unsetObjectIsContainer, unsetOwner, unsetOwnerCUID, unsetParentCUID, unsetPluginInfo, unsetRolesOnObject, unsetRUID, unsetSchedulable, unsetSecurityInfo, unsetSecurityInfo2, unsetSharedDoc, unsetStartTime, unsetUiStatus, unsetUpdateTime, xgetChildrenObjects, xgetCreationTime, xgetCUID, xgetDescription, xgetEndTime, xgetErrorMessage, xgetGUID, xgetID, xgetInstance, xgetInstanceObject, xgetIsApplicationObject, xgetIsComponent, xgetIsHiddenObject, xgetIsPluginObject, xgetIsRecurring, xgetIsRunnableObject, xgetIsSendable, xgetIsSystemObject, xgetKey, xgetKeywords, xgetKind, xgetLastRunTime, xgetLastSuccessfulInstanceCUID, xgetName, xgetNewJobID, xgetNextRunTime, xgetObjectIsContainer, xgetOwner, xgetOwnerCUID, xgetParentCUID, xgetRUID, xgetSchedulable, xgetStartTime, xgetUiStatus, xgetUpdateTime, xsetChildrenObjects, xsetCreationTime, xsetCUID, xsetDescription, xsetEndTime, xsetErrorMessage, xsetGUID, xsetID, xsetInstance, xsetInstanceObject, xsetIsApplicationObject, xsetIsComponent, xsetIsHiddenObject, xsetIsPluginObject, xsetIsRecurring, xsetIsRunnableObject, xsetIsSendable, xsetIsSystemObject, xsetKey, xsetKeywords, xsetKind, xsetLastRunTime, xsetLastSuccessfulInstanceCUID, xsetName, xsetNewJobID, xsetNextRunTime, xsetObjectIsContainer, xsetOwner, xsetOwnerCUID, xsetParentCUID, xsetRUID, xsetSchedulable, xsetStartTime, xsetUiStatus, xsetUpdateTime

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getSchedulingInfo

SchedulingInfo getSchedulingInfo()

Returns the scheduling information for the object. It will be an empty reference if the object does not support scheduling.

Returns:

A SchedulingInfo object containing this object's scheduling information.

isSetSchedulingInfo

boolean isSetSchedulingInfo()

Checks if the SchedulingInfo has been set.

Returns:

true if the SchedulingInfo element has been set, false.

setSchedulingInfo

void setSchedulingInfo(SchedulingInfo schedulingInfo)

Sets the scheduling information for the object.

Parameters:

schedulingInfo - A SchedulingInfo object containing this object's scheduling information.

addNewSchedulingInfo

SchedulingInfo addNewSchedulingInfo()

Appends and returns a new empty SchedulingInfo object to the last element of the array.

Returns:

A new SchedulingInfo.

unsetSchedulingInfo

void unsetSchedulingInfo()

Deletes or unsets the SchedulingInfo element.

getFileProperties

FileProperties getFileProperties()

Returns the InfoObject's associated files.

Returns:

The InfoObject's associated files.

isSetFileProperties

boolean isSetFileProperties()

Checks if the FileProperties has been set.

Returns:

true if the FileProperties element has been set, false.

setFileProperties

void setFileProperties(FileProperties fileProperties)

Sets the InfoObject's associated files.

Parameters:

fileProperties - The InfoObject's associated files.

addNewFileProperties

FileProperties addNewFileProperties()

Appends and returns a new empty FileProperties object to the last element of the array.

Returns:

A new FileProperties.

unsetFileProperties

void unsetFileProperties()

Deletes or unsets the FileProperties element.

getCorporateCategories

CorporateCategories getCorporateCategories()

Returns the ID set of top-level categories that have been assigned to the object.

Returns:

A set of category IDs that have been assigned to the object.

isSetCorporateCategories

boolean isSetCorporateCategories()

Checks if the CorporateCategories has been set.

Returns:

true if the CorporateCategories element has been set, false.

setCorporateCategories

void setCorporateCategories(CorporateCategories corporateCategories)

Sets the ID set of top-level categories.

Parameters:

corporateCategories - A set of category IDs that have been assigned to the object.

addNewCorporateCategories

CorporateCategories addNewCorporateCategories()

Appends and returns a new empty CorporateCategories object to the last element of the array.

Returns:

A new CorporateCategories.

unsetCorporateCategories

void unsetCorporateCategories()

Deletes or unsets the CorporateCategories element.

getPersonalCategories

PersonalCategories getPersonalCategories()

Returns the ID set of top-level personal categories that have been assigned to the object.

Returns:

A set of category IDs that have been assigned to the object.

isSetPersonalCategories

boolean isSetPersonalCategories()

Checks if the PersonalCategories has been set.

Returns:

true if the PersonalCategories element has been set,otherwise false.

setPersonalCategories

void setPersonalCategories(PersonalCategories personalCategories)

Sets the ID set of top-level personal categories.

Parameters:

personalCategories - A set of category IDs that have been assigned to the object.

addNewPersonalCategories

PersonalCategories addNewPersonalCategories()

Appends and returns a new empty PersonalCategories object to the last element of the array.

Returns:

A new PersonalCategories.

unsetPersonalCategories

void unsetPersonalCategories()

Deletes or unsets the PersonalCategories element.

getEncyclopediaTopics

EncyclopediaTopics getEncyclopediaTopics()

Internal Use Only.

isSetEncyclopediaTopics

boolean isSetEncyclopediaTopics()

Internal Use Only.

setEncyclopediaTopics

void setEncyclopediaTopics(EncyclopediaTopics encyclopediaTopics)

Internal Use Only.

addNewEncyclopediaTopics

EncyclopediaTopics addNewEncyclopediaTopics()

Internal Use Only.

unsetEncyclopediaTopics

void unsetEncyclopediaTopics()

Internal Use Only.

getAnalyticActivities

AnalyticActivities getAnalyticActivities()

Internal Use Only.

isSetAnalyticActivities

boolean isSetAnalyticActivities()

Internal Use Only.

setAnalyticActivities

void setAnalyticActivities(AnalyticActivities analyticActivities)

Internal Use Only.

addNewAnalyticActivities

AnalyticActivities addNewAnalyticActivities()

Internal Use Only.

unsetAnalyticActivities

void unsetAnalyticActivities()

Internal Use Only.

getFullClientProcessingInfo

FullClientProcessingInfo getFullClientProcessingInfo()

Returns the document properties.

Returns:

The document properties.

isSetFullClientProcessingInfo

boolean isSetFullClientProcessingInfo()

Checks if the FullClientProcessingInfo has been set.

Returns:

true if the FullClientProcessingInfo element has been set,otherwise false.

setFullClientProcessingInfo

void setFullClientProcessingInfo(FullClientProcessingInfo fullClientProcessingInfo)

Sets the document properties.

Parameters:

fullClientProcessingInfo - The document properties.

addNewFullClientProcessingInfo

FullClientProcessingInfo addNewFullClientProcessingInfo()

Appends and returns a new empty FullClientProcessingInfo object to the last element of the array.

Returns:

A new FullClientProcessingInfo.

unsetFullClientProcessingInfo

void unsetFullClientProcessingInfo()

Deletes or unsets the FullClientProcessingInfo element.

getProcessingProgID

java.lang.String getProcessingProgID()

Internal Use Only.

xgetProcessingProgID

org.apache.xmlbeans.XmlString xgetProcessingProgID()

Internal Use Only.

isSetProcessingProgID

boolean isSetProcessingProgID()

Internal Use Only.

setProcessingProgID

void setProcessingProgID(java.lang.String processingProgID)

Internal Use Only.

xsetProcessingProgID

void xsetProcessingProgID(org.apache.xmlbeans.XmlString processingProgID)

Internal Use Only.

unsetProcessingProgID

void unsetProcessingProgID()

Internal Use Only.

getCustomProperties

CustomProperties getCustomProperties()

Returns the custom properties.

Returns:

The custom properties.

isSetCustomProperties

boolean isSetCustomProperties()

Checks if the CustomProperties has been set.

Returns:

true if the CustomProperties element has been set,otherwise false.

setCustomProperties

void setCustomProperties(CustomProperties customProperties)

Sets the custom properties.

Parameters:

customProperties - The custom properties.

addNewCustomProperties

CustomProperties addNewCustomProperties()

Appends and returns a new empty CustomProperties object to the last element of the array.

Returns:

A new CustomProperties.

unsetCustomProperties

void unsetCustomProperties()

Deletes or unsets the CustomProperties element.