oracle.webcenter.spaces.ws.client

Class GroupSpaceWSMetadata

java.lang.Object

oracle.webcenter.spaces.ws.client.GroupSpaceWSMetadata

All Implemented Interfaces:

java.io.Serializable, GSMetadata

public final class GroupSpaceWSMetadata
extends java.lang.Object
implements GSMetadata

This class is responsible for providing metadata for given WebCenter Group Space. This class is responsible for providing metadata related to any Group Space. It should be used with GroupSpaceWSClient class methods which return the instance of this class. It is recommended that users should get the instance of this class from the methods of GroupSpaceWSClient. It provides different properties/attributes of Group Spaces like the description of the group space, who created the group space, Icon URL of the group space, Keywords used to denote the group space, mailing list, Group Space Logo, the state of the group space, when the group space was last updated, who all are the members of the group space and any custom attributes defined with the group space. One can get the URL of the group space from class GroupSpaceWSClient

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GroupSpaceWSMetadata(oracle.webcenter.spaces.internal.ws.client.proxy.types.GsMetadataImpl metadata) Constructor of this class..

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAcronym() This method returns the acronym of group space logo url
java.util.List<ServiceMetadata>	getAllServiceMetadata() Returns the list of all service metadata.
int	getChildGSCount() THIS API returns the childGS count
java.lang.String	getCopyRightMessage() This API fetches the copyrightMessage
java.lang.String	getCreatedBy() Returns the creator's name of the Group Space
java.util.Calendar	getCreatedDate() This method returns the created date
java.util.List<GSCustomAttribute>	getCustomAttributes() This API returns custom attributes for a current Group Space.
java.lang.String	getDescription() Returns the description of the Group Space
java.lang.String	getDisplayName() Returns the display name of the Group Space
java.lang.String	getGroupSpaceURI() This method returns pretty url of the Group space like spaces/
java.lang.String	getGuid() Retruns the GUID of the GS
java.lang.String	getIconURI() Returns the location of the group space Icon
java.lang.String	getKeywords() Returns the comma separated list of Keywords which define the Group Space
java.util.Calendar	getLastActivityTime() THIS API returns the last activity time
javax.xml.datatype.XMLGregorianCalendar	getLastUpdated() Returns the last Updated Date of current Group Space in the format of Gregorian Calender
java.util.Calendar	getLastUpdatedDate() This method returns the last updated date
java.lang.String	getLogoURI() Returns the location of the Logo of the Group Space
java.lang.String	getMailingList() Returns the mailing list for the current group space
int	getMemberCount() THIS API returns the member count
java.util.List<GroupSpaceWSMembers>	getMembers()
java.lang.String	getName() Returns the name of the Group Space
java.lang.String	getParentGuid() This API returns the Guid of the parent scope
java.lang.String	getPortalColor() This method returns the portal color of group space logo url
java.lang.String	getPreview() This method returns the preview of group space logo url
java.lang.String	getPrivacyURL() This API fetches the privacyURL
java.util.List<java.lang.String>	getProvisionedServicesId() This method returns the list of provisioned services Id
java.lang.String	getSecurityParentGuid() This API returns the guid of the security parent
java.lang.String	getSelfRegPage() This API returns the self registration page of a scope
java.util.List<java.lang.String>	getSelfSubscriptionEnabledRoles() This API fetches the privacyURL
GSServiceConfigData	getServiceConfigData(java.lang.String serviceId) This method returns the GSServiceMetadata and GSServiceMetadata.getServiceAttibutes() returns the service attributes
boolean	isClosed() This method returns if the Group Space is closed or open
boolean	isDiscoverable() Returns if the group Is discoverable
boolean	isFooterHidden() This API checks if the footer is hidden
boolean	isOffline() This method returns boolean if the Group space is online or offline
boolean	isPublic() Deprecated.
boolean	isPubliclyViewable() Returns if the Group Space is Public
boolean	isSeeded() This method returns if the Group Space is public or now
boolean	isSelfSubEnabled() This method returns boolean if the Group space is enabled for self subscription

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupSpaceWSMetadata

public GroupSpaceWSMetadata(oracle.webcenter.spaces.internal.ws.client.proxy.types.GsMetadataImpl metadata)

Constructor of this class.. Throws IllegalArgumentException if parameter is ull or empty

Parameters:

metadata - SpaceType Metadata

Method Detail

getDisplayName

public java.lang.String getDisplayName()

Returns the display name of the Group Space

Specified by:

getDisplayName in interface GSMetadata

Returns:

Display Name of the Group Space

getName

public java.lang.String getName()

Returns the name of the Group Space

Specified by:

getName in interface GSMetadata

Returns:

Name of the Group Space

getCreatedBy

public java.lang.String getCreatedBy()

Returns the creator's name of the Group Space

Specified by:

getCreatedBy in interface GSMetadata

Returns:

The name of the identity who created the group space

getDescription

public java.lang.String getDescription()

Returns the description of the Group Space

Specified by:

getDescription in interface GSMetadata

Returns:

The description of the group space

getIconURI

public java.lang.String getIconURI()

Returns the location of the group space Icon

Specified by:

getIconURI in interface GSMetadata

Returns:

Icon location

getPortalColor

public java.lang.String getPortalColor()

This method returns the portal color of group space logo url

Specified by:

getPortalColor in interface GSMetadata

Returns:

String

getAcronym

public java.lang.String getAcronym()

This method returns the acronym of group space logo url

Specified by:

getAcronym in interface GSMetadata

Returns:

String

getPreview

public java.lang.String getPreview()

This method returns the preview of group space logo url

Specified by:

getPreview in interface GSMetadata

Returns:

String

getKeywords

public java.lang.String getKeywords()

Returns the comma separated list of Keywords which define the Group Space

Specified by:

getKeywords in interface GSMetadata

Returns:

Comma separated list of string i.e. keywords

getLogoURI

public java.lang.String getLogoURI()

Returns the location of the Logo of the Group Space

Specified by:

getLogoURI in interface GSMetadata

Returns:

Location of the Group Space Logo

getLastUpdated

public javax.xml.datatype.XMLGregorianCalendar getLastUpdated()

Returns the last Updated Date of current Group Space in the format of Gregorian Calender

Returns:

The Last updated date in Gregorial Calender format

getMailingList

public java.lang.String getMailingList()

Returns the mailing list for the current group space

Specified by:

getMailingList in interface GSMetadata

Returns:

Returns the mailing list/distribution list for current Group Space

getMembers

public java.util.List<GroupSpaceWSMembers> getMembers()

Returns:

Returns List. Each GroupSpaceWSMembers contains 3 methods, which gives details about the member name,isGroup and their role.

getAllServiceMetadata

public java.util.List<ServiceMetadata> getAllServiceMetadata()

Returns the list of all service metadata. i.e. The service metadata list currently provisioned in Group Space.

Returns:

Returns List. Each ServiceMetadata contains the service id and the map.

getCustomAttributes

public java.util.List<GSCustomAttribute> getCustomAttributes()

This API returns custom attributes for a current Group Space.

Returns custom attributes for given Space name. Each custom a support following attributes: name, description, type, value. CustomAttribute metadata is a bean and users can get the information about the attributes.

Look at the following example:
GroupSpaceWSClient wsClient = GroupSpaceWSClient().getInstance();
GroupSpaceWSMetadata metadata = wsClient.getGroupSpaceMetadata("FinanceProject");
List attributes = wsClient.getCustomAttributes();
for(CustomMetadata.Attribute attribute: attributes)
{
System.out.println("Name :" + attribute.getName());
System.out.println("Description :" + attribute.getDescription());
System.out.println("Type :" + attribute.getType());
System.out.println("value.toString() :" + attribute.getValue().toString());
}
This attribute object should be used only at the time of creating the a Group Space

Specified by:

getCustomAttributes in interface GSMetadata

Returns:

Returns the list of custom attribute Beans for current Group Space

isDiscoverable

public boolean isDiscoverable()

Returns if the group Is discoverable

Specified by:

isDiscoverable in interface GSMetadata

Returns:

true if discoverable

isPubliclyViewable

public boolean isPubliclyViewable()

Returns if the Group Space is Public

Returns:

true if public

getGuid

public java.lang.String getGuid()

Retruns the GUID of the GS

Specified by:

getGuid in interface GSMetadata

Returns:

getProvisionedServicesId

public java.util.List<java.lang.String> getProvisionedServicesId()

Description copied from interface: GSMetadata

This method returns the list of provisioned services Id

Specified by:

getProvisionedServicesId in interface GSMetadata

Returns:

List

getServiceConfigData

public GSServiceConfigData getServiceConfigData(java.lang.String serviceId)

Description copied from interface: GSMetadata

This method returns the GSServiceMetadata and GSServiceMetadata.getServiceAttibutes() returns the service attributes

Specified by:

getServiceConfigData in interface GSMetadata

Returns:

List

isOffline

public boolean isOffline()

Description copied from interface: GSMetadata

This method returns boolean if the Group space is online or offline

Specified by:

isOffline in interface GSMetadata

Returns:

boolean

isClosed

public boolean isClosed()

Description copied from interface: GSMetadata

This method returns if the Group Space is closed or open

Specified by:

isClosed in interface GSMetadata

Returns:

boolean

getLastUpdatedDate

public java.util.Calendar getLastUpdatedDate()

Description copied from interface: GSMetadata

This method returns the last updated date

Specified by:

getLastUpdatedDate in interface GSMetadata

Returns:

Calendar

getGroupSpaceURI

public java.lang.String getGroupSpaceURI()

Description copied from interface: GSMetadata

This method returns pretty url of the Group space like spaces/

Specified by:

getGroupSpaceURI in interface GSMetadata

Returns:

String

isSelfSubEnabled

public boolean isSelfSubEnabled()

Description copied from interface: GSMetadata

This method returns boolean if the Group space is enabled for self subscription

Specified by:

isSelfSubEnabled in interface GSMetadata

Returns:

boolean

getCreatedDate

public java.util.Calendar getCreatedDate()

Description copied from interface: GSMetadata

This method returns the created date

Specified by:

getCreatedDate in interface GSMetadata

Returns:

Calendar

isPublic

@Deprecated
public boolean isPublic()

Deprecated.

Description copied from interface: GSMetadata

This method returns if the Group Space is public or now

Specified by:

isPublic in interface GSMetadata

Returns:

boolean

isSeeded

public boolean isSeeded()

This method returns if the Group Space is public or now

Specified by:

isSeeded in interface GSMetadata

Returns:

boolean

getChildGSCount

public int getChildGSCount()

THIS API returns the childGS count

Specified by:

getChildGSCount in interface GSMetadata

getMemberCount

public int getMemberCount()

THIS API returns the member count

Specified by:

getMemberCount in interface GSMetadata

getLastActivityTime

public java.util.Calendar getLastActivityTime()

THIS API returns the last activity time

Specified by:

getLastActivityTime in interface GSMetadata

isFooterHidden

public boolean isFooterHidden()

Description copied from interface: GSMetadata

This API checks if the footer is hidden

Specified by:

isFooterHidden in interface GSMetadata

Returns:

getSelfRegPage

public java.lang.String getSelfRegPage()

Description copied from interface: GSMetadata

This API returns the self registration page of a scope

Specified by:

getSelfRegPage in interface GSMetadata

getSelfSubscriptionEnabledRoles

public java.util.List<java.lang.String> getSelfSubscriptionEnabledRoles()

Description copied from interface: GSMetadata

This API fetches the privacyURL

Specified by:

getSelfSubscriptionEnabledRoles in interface GSMetadata

Returns:

getPrivacyURL

public java.lang.String getPrivacyURL()

Description copied from interface: GSMetadata

This API fetches the privacyURL

Specified by:

getPrivacyURL in interface GSMetadata

Returns:

getCopyRightMessage

public java.lang.String getCopyRightMessage()

Description copied from interface: GSMetadata

This API fetches the copyrightMessage

Specified by:

getCopyRightMessage in interface GSMetadata

Returns:

getParentGuid

public java.lang.String getParentGuid()

Description copied from interface: GSMetadata

This API returns the Guid of the parent scope

Specified by:

getParentGuid in interface GSMetadata

Returns:

getSecurityParentGuid

public java.lang.String getSecurityParentGuid()

Description copied from interface: GSMetadata

This API returns the guid of the security parent

Specified by:

getSecurityParentGuid in interface GSMetadata

Returns: