|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface Universe
Contains properties and methods that allow you to manage universe metrics.
The information that you can retrieve through this interface includes database connection parameters, universe relationship structure, and principal (user and user group) rights.
| Nested Class Summary | |
|---|---|
static class |
Universe.Factory
A class with methods for creating instances of the Universe type. |
| Field Summary | |
|---|---|
static org.apache.xmlbeans.SchemaType |
type
Internal Use Only. |
| Method Summary | |
|---|---|
CoreUniverses |
addNewCoreUniverses()
Appends and returns a new empty CoreUniverses object as the last element of the array. |
CustomProperties |
addNewCustomProperties()
Appends and returns a new empty CustomProperties object as the last element of the array. |
DataConnections |
addNewDataConnections()
Appends and returns a new empty DataConnections object as the last element of the array. |
Deriveduniverses |
addNewDerivedUniverses()
Appends and returns a new empty Deriveduniverses object as the last element of the array. |
FileProperties |
addNewFileProperties()
Appends and returns a new empty FileProperties object as the last element of the array. |
UserGroupOrderedIDs |
addNewUserGroupOrderedIDs()
Appends and returns a new empty UserGroupOrderedIDs object as the last element of the array. |
Webis |
addNewWebis()
Appends and returns a new empty Webis object as the last element of the array. |
java.lang.String |
getAndOrOption()
Returns the AND/OR option as a String value. |
CoreUniverses |
getCoreUniverses()
Returns the core universes that are assigned to this universe object. |
CustomProperties |
getCustomProperties()
Returns the custom properties. |
DataConnections |
getDataConnections()
Returns the data connections assigned to this universe object. |
Deriveduniverses |
getDerivedUniverses()
Returns the derived universes that are assigned to this universe object. |
java.lang.String |
getE65Comment()
Internal Use Only. |
java.lang.String |
getE65Cuid()
Internal Use Only. |
java.lang.String |
getE65Id()
Internal Use Only. |
java.lang.String |
getE65RepositoryName()
Internal Use Only. |
java.lang.String |
getFilename()
Returns the original universe file name. |
FileProperties |
getFileProperties()
Returns the InfoObject's associated files. |
java.lang.String |
getLockerCUID()
Returns the locker ID for this universe object. |
int |
getRevisionNumber()
Returns the revision number that is assigned to this universe object. |
java.lang.String |
getShortName()
Returns the short name for this universe object. |
java.lang.String |
getUpdateObject()
Internal Use Only. |
UserGroupOrderedIDs |
getUserGroupOrderedIDs()
Returns the user group ordered IDs that are assigned to this universe object. |
Webis |
getWebis()
Returns a collection of identifiers that represent Web Intelligence documents that are assigned to this universe object. |
boolean |
isSetAndOrOption()
Internal Use Only. |
boolean |
isSetCoreUniverses()
Checks if the core universes assigned to this universe object have been set. |
boolean |
isSetCustomProperties()
Checks if the custom properties have been set. |
boolean |
isSetDerivedUniverses()
Checks if the derived universes assigned to this universe object have been set. |
boolean |
isSetE65Comment()
Internal Use Only. |
boolean |
isSetE65Cuid()
Internal Use Only. |
boolean |
isSetE65Id()
Internal Use Only. |
boolean |
isSetE65RepositoryName()
Internal Use Only. |
boolean |
isSetFilename()
Internal Use Only. |
boolean |
isSetFileProperties()
Checks if the InfoObject's associated files have been set. |
boolean |
isSetLockerCUID()
Checks if the locker ID for this universe object has been set. |
boolean |
isSetRevisionNumber()
Checks if the revision number assigned to this universe object has been set. |
boolean |
isSetShortName()
Checks if the short name for this universe object has been set. |
boolean |
isSetUpdateObject()
Internal Use Only. |
boolean |
isSetUserGroupOrderedIDs()
Checks if the user group ordered IDs assigned to this universe object have been set. |
boolean |
isSetWebis()
Checks if the collection of identifiers that represent the Web Intelligence documents assigned to this univers object have been set. |
void |
setAndOrOption(java.lang.String andOrOption)
Internal Use Only. |
void |
setCoreUniverses(CoreUniverses coreUniverses)
Sets the core universes that are assigned to this universe object. |
void |
setCustomProperties(CustomProperties customProperties)
Sets the custom properties. |
void |
setDataConnections(DataConnections dataConnections)
Sets the data connections assigned to this universe object. |
void |
setDerivedUniverses(Deriveduniverses derivedUniverses)
Sets the derived universes that are assigned to this universe object. |
void |
setE65Comment(java.lang.String e65Comment)
Internal Use Only. |
void |
setE65Cuid(java.lang.String e65Cuid)
Internal Use Only. |
void |
setE65Id(java.lang.String e65Id)
Internal Use Only. |
void |
setE65RepositoryName(java.lang.String e65RepositoryName)
Internal Use Only. |
void |
setFilename(java.lang.String filename)
Internal Use Only. |
void |
setFileProperties(FileProperties fileProperties)
Sets the InfoObject's associated files. |
void |
setLockerCUID(java.lang.String lockerCUID)
Sets the locker ID for this universe object. |
void |
setRevisionNumber(int revisionNumber)
Sets the revision number that is assigned to this universe object. |
void |
setShortName(java.lang.String shortName)
Sets the short name for this universe object. |
void |
setUpdateObject(java.lang.String updateObject)
Internal Use Only. |
void |
setUserGroupOrderedIDs(UserGroupOrderedIDs userGroupOrderedIDs)
Sets the user group ordered IDs that are assigned to this universe object. |
void |
setWebis(Webis webis)
Sets a collection of identifiers that represent Web Intelligence documents that are assigned to this universe object. |
void |
unsetAndOrOption()
Internal Use Only. |
void |
unsetCoreUniverses()
Deletes or unsets the CoreUniverses element. |
void |
unsetCustomProperties()
Deletes or unsets the CustomProperties element. |
void |
unsetDerivedUniverses()
Deletes or unsets the derived universes that are assigned to this universe object. |
void |
unsetE65Comment()
Internal Use Only. |
void |
unsetE65Cuid()
Internal Use Only. |
void |
unsetE65Id()
Internal Use Only. |
void |
unsetE65RepositoryName()
Internal Use Only. |
void |
unsetFilename()
Internal Use Only. |
void |
unsetFileProperties()
Deletes or unsets the FileProperties element. |
void |
unsetLockerCUID()
Deletes or unsets the LockerCUID element. |
void |
unsetRevisionNumber()
Deletes or unsets the revision number assigned to this universe object. |
void |
unsetShortName()
Deletes or unsets the ShortName element. |
void |
unsetUpdateObject()
Internal Use Only. |
void |
unsetUserGroupOrderedIDs()
Deletes or unsets the UserGroupOrderedIDs element. |
void |
unsetWebis()
Deletes or unsets the Webis element. |
org.apache.xmlbeans.XmlString |
xgetAndOrOption()
Internal Use Only. |
org.apache.xmlbeans.XmlString |
xgetE65Comment()
Internal Use Only. |
org.apache.xmlbeans.XmlString |
xgetE65Cuid()
Internal Use Only. |
org.apache.xmlbeans.XmlString |
xgetE65Id()
Internal Use Only. |
org.apache.xmlbeans.XmlString |
xgetE65RepositoryName()
Internal Use Only. |
org.apache.xmlbeans.XmlString |
xgetFilename()
Internal Use Only. |
org.apache.xmlbeans.XmlString |
xgetLockerCUID()
Internal Use Only. |
org.apache.xmlbeans.XmlInt |
xgetRevisionNumber()
Internal Use Only. |
org.apache.xmlbeans.XmlString |
xgetShortName()
Internal Use Only. |
org.apache.xmlbeans.XmlString |
xgetUpdateObject()
Internal Use Only. |
void |
xsetAndOrOption(org.apache.xmlbeans.XmlString andOrOption)
Internal Use Only. |
void |
xsetE65Comment(org.apache.xmlbeans.XmlString e65Comment)
Internal Use Only. |
void |
xsetE65Cuid(org.apache.xmlbeans.XmlString e65Cuid)
Internal Use Only. |
void |
xsetE65Id(org.apache.xmlbeans.XmlString e65Id)
Internal Use Only. |
void |
xsetE65RepositoryName(org.apache.xmlbeans.XmlString e65RepositoryName)
Internal Use Only. |
void |
xsetFilename(org.apache.xmlbeans.XmlString filename)
Internal Use Only. |
void |
xsetLockerCUID(org.apache.xmlbeans.XmlString lockerCUID)
Internal Use Only. |
void |
xsetRevisionNumber(org.apache.xmlbeans.XmlInt revisionNumber)
Internal Use Only. |
void |
xsetShortName(org.apache.xmlbeans.XmlString shortName)
Internal Use Only. |
void |
xsetUpdateObject(org.apache.xmlbeans.XmlString updateObject)
Internal Use Only. |
| Field Detail |
|---|
static final org.apache.xmlbeans.SchemaType type
| Method Detail |
|---|
FileProperties getFileProperties()
Returns the InfoObject's associated files.
boolean isSetFileProperties()
Checks if the InfoObject's associated files have been set.
true if the FileProperties element has been set,otherwise false.void setFileProperties(FileProperties fileProperties)
Sets the InfoObject's associated files.
fileProperties - The InfoObject's associated files.FileProperties addNewFileProperties()
FileProperties object as the last element of the array.
FileProperties object.void unsetFileProperties()
Deletes or unsets the FileProperties element.
UserGroupOrderedIDs getUserGroupOrderedIDs()
Returns the user group ordered IDs that are assigned to this universe object.
boolean isSetUserGroupOrderedIDs()
Checks if the user group ordered IDs assigned to this universe object have been set.
true if the UserGroupOrderedIDs element has been set,otherwise false.void setUserGroupOrderedIDs(UserGroupOrderedIDs userGroupOrderedIDs)
Sets the user group ordered IDs that are assigned to this universe object.
userGroupOrderedIDs - The user group ordered IDs that are assigned to this universe object.UserGroupOrderedIDs addNewUserGroupOrderedIDs()
UserGroupOrderedIDs object as the last element of the array.
UserGroupOrderedIDs object.void unsetUserGroupOrderedIDs()
Deletes or unsets the UserGroupOrderedIDs element.
CoreUniverses getCoreUniverses()
Returns the core universes that are assigned to this universe object.
A core universe is the building block, or base, for a derived universe. For more information on universes, see the BusinessObjects Designer’s Guide.
Note: A universe can be defined from one or more universes.
boolean isSetCoreUniverses()
Checks if the core universes assigned to this universe object have been set.
true if the CoreUniverses element has been set,otherwise false.void setCoreUniverses(CoreUniverses coreUniverses)
Sets the core universes that are assigned to this universe object.
A core universe is the building block, or base, for a derived universe. For more information on universes, see the BusinessObjects Designer’s Guide.
Note: A universe can be defined from one or more universes.
coreUniverses - The core universes that are assigned to this universe object.CoreUniverses addNewCoreUniverses()
CoreUniverses object as the last element of the array.
CoreUniverses object.void unsetCoreUniverses()
Deletes or unsets the CoreUniverses element.
Webis getWebis()
Returns a collection of identifiers that represent Web Intelligence documents that are assigned to this universe object.
boolean isSetWebis()
Checks if the collection of identifiers that represent the Web Intelligence documents assigned to this univers object have been set.
true if the Webis element has been set,otherwise false.void setWebis(Webis webis)
Sets a collection of identifiers that represent Web Intelligence documents that are assigned to this universe object.
webis - A collection of identifiers that represent Web Intelligence documents that are assigned to this universe object.Webis addNewWebis()
Webis object as the last element of the array.
Webis object.void unsetWebis()
Deletes or unsets the Webis element.
java.lang.String getE65RepositoryName()
org.apache.xmlbeans.XmlString xgetE65RepositoryName()
boolean isSetE65RepositoryName()
void setE65RepositoryName(java.lang.String e65RepositoryName)
void xsetE65RepositoryName(org.apache.xmlbeans.XmlString e65RepositoryName)
void unsetE65RepositoryName()
java.lang.String getE65Cuid()
org.apache.xmlbeans.XmlString xgetE65Cuid()
boolean isSetE65Cuid()
void setE65Cuid(java.lang.String e65Cuid)
void xsetE65Cuid(org.apache.xmlbeans.XmlString e65Cuid)
void unsetE65Cuid()
java.lang.String getE65Comment()
org.apache.xmlbeans.XmlString xgetE65Comment()
boolean isSetE65Comment()
void setE65Comment(java.lang.String e65Comment)
void xsetE65Comment(org.apache.xmlbeans.XmlString e65Comment)
void unsetE65Comment()
java.lang.String getUpdateObject()
org.apache.xmlbeans.XmlString xgetUpdateObject()
boolean isSetUpdateObject()
void setUpdateObject(java.lang.String updateObject)
void xsetUpdateObject(org.apache.xmlbeans.XmlString updateObject)
void unsetUpdateObject()
java.lang.String getE65Id()
org.apache.xmlbeans.XmlString xgetE65Id()
boolean isSetE65Id()
void setE65Id(java.lang.String e65Id)
void xsetE65Id(org.apache.xmlbeans.XmlString e65Id)
void unsetE65Id()
int getRevisionNumber()
Returns the revision number that is assigned to this universe object.
The revision number indicates the amount of times a universe has been exported to a universe domain.
org.apache.xmlbeans.XmlInt xgetRevisionNumber()
boolean isSetRevisionNumber()
Checks if the revision number assigned to this universe object has been set.
true if the RevisionNumber element has been set,otherwise false.void setRevisionNumber(int revisionNumber)
Sets the revision number that is assigned to this universe object.
The revision number indicates the amount of times a universe has been exported to a universe domain.
revisionNumber - The revision number.void xsetRevisionNumber(org.apache.xmlbeans.XmlInt revisionNumber)
void unsetRevisionNumber()
Deletes or unsets the revision number assigned to this universe object.
java.lang.String getLockerCUID()
Returns the locker ID for this universe object.
Identifies the ID of the user who has locked the universe.
org.apache.xmlbeans.XmlString xgetLockerCUID()
boolean isSetLockerCUID()
Checks if the locker ID for this universe object has been set.
void setLockerCUID(java.lang.String lockerCUID)
Sets the locker ID for this universe object.
Identifies the ID of the user who has locked the universe.
lockerCUID - The locker ID for this universe object.void xsetLockerCUID(org.apache.xmlbeans.XmlString lockerCUID)
void unsetLockerCUID()
Deletes or unsets the LockerCUID element.
java.lang.String getFilename()
Returns the original universe file name.
org.apache.xmlbeans.XmlString xgetFilename()
boolean isSetFilename()
void setFilename(java.lang.String filename)
void xsetFilename(org.apache.xmlbeans.XmlString filename)
void unsetFilename()
java.lang.String getShortName()
Returns the short name for this universe object.
String that represents the short name of this universe.org.apache.xmlbeans.XmlString xgetShortName()
boolean isSetShortName()
Checks if the short name for this universe object has been set.
true if the SetShortName element has been set,otherwise false.void setShortName(java.lang.String shortName)
Sets the short name for this universe object.
shortName - A String that represents the short name of this universe.void xsetShortName(org.apache.xmlbeans.XmlString shortName)
void unsetShortName()
Deletes or unsets the ShortName element.
java.lang.String getAndOrOption()
Returns the AND/OR option as a String value.
String value that indicates whether the AND/OR option is enabled.org.apache.xmlbeans.XmlString xgetAndOrOption()
boolean isSetAndOrOption()
void setAndOrOption(java.lang.String andOrOption)
void xsetAndOrOption(org.apache.xmlbeans.XmlString andOrOption)
void unsetAndOrOption()
DataConnections getDataConnections()
Returns the data connections assigned to this universe object.
void setDataConnections(DataConnections dataConnections)
Sets the data connections assigned to this universe object.
dataConnections - The data connection IDs assigned to this universe object.DataConnections addNewDataConnections()
DataConnections object as the last element of the array.
DataConnections object.Deriveduniverses getDerivedUniverses()
Returns the derived universes that are assigned to this universe object.
boolean isSetDerivedUniverses()
Checks if the derived universes assigned to this universe object have been set.
true if the DerivedUniverses element has been set,otherwise false.void setDerivedUniverses(Deriveduniverses derivedUniverses)
Sets the derived universes that are assigned to this universe object.
derivedUniverses - The derived universes that are assigned to this universe object.Deriveduniverses addNewDerivedUniverses()
Deriveduniverses object as the last element of the array.
Deriveduniverses object.void unsetDerivedUniverses()
Deletes or unsets the derived universes that are assigned to this universe object.
CustomProperties getCustomProperties()
Returns the custom properties.
boolean isSetCustomProperties()
Checks if the custom properties have been set.
true if the CustomProperties element has been set,otherwise false.void setCustomProperties(CustomProperties customProperties)
Sets the custom properties.
customProperties - The custom properties.CustomProperties addNewCustomProperties()
CustomProperties object as the last element of the array.
CustomProperties object.void unsetCustomProperties()
Deletes or unsets the CustomProperties element.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||