com.esri.core.portal
Class PortalGroup

java.lang.Object
  extended by com.esri.core.portal.PortalGroup

public class PortalGroup
extends Object

This class represents a Group in a Portal.


Method Summary
 boolean equals(Object obj)
          
 void fetchThumbnail(PortalListener<byte[]> portalListener)
          Fetches the thumbnail for this group.
 void fetchUsers(PortalListener<Void> portalListener)
          Fetches the membership details for the group.
static PortalGroup fromJson(org.codehaus.jackson.JsonParser parser, Portal portal)
           
 PortalAccess getAccess()
          Returns the access level of this group.
 List<String> getAdmins()
          Returns the admins of this group.
 long getCreated()
          Returns the date on which this group was created.
 String getDescription()
          Returns the description of this group.
 String getGroupId()
          Returns the id of this group.
 long getModified()
          Returns the last date on which this group was modified.
 String getOwner()
          Returns the owner of this group.
 Portal getPortal()
          Returns the portal that contains this group.
 String getSnippet()
          Returns a description snippet for this group.
 List<String> getTags()
          Returns a list of tags associated with this group.
 byte[] getThumbnail()
          Returns the thumbnail of this group.
 String getThumbnailFileName()
          Returns the filename of the thumbnail of this group.
 String getTitle()
          Returns the title of this group.
 List<String> getUsers()
          Returns the users that belong to this group.
 int hashCode()
          
 boolean isInvitationOnly()
          Returns whether or not this group requires an invitation to join.
 String toString()
          
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Method Detail

fetchUsers

public void fetchUsers(PortalListener<Void> portalListener)
Fetches the membership details for the group. Important Note: The listener will return a null object in the onCallback method. You can instead access the users and admin properties via the getUsers() and getAdmins() methods after the onCallback method on the listener is called.

Parameters:
portalListener - - fetches the users from the portal

fetchThumbnail

public void fetchThumbnail(PortalListener<byte[]> portalListener)
Fetches the thumbnail for this group.

Parameters:
portalListener - - fetches the thumbnail associated with the group

fromJson

public static PortalGroup fromJson(org.codehaus.jackson.JsonParser parser,
                                   Portal portal)
                            throws Exception
Throws:
Exception

getPortal

public Portal getPortal()
Returns the portal that contains this group.

Returns:
The portal that contains this group

getGroupId

public String getGroupId()
Returns the id of this group.

Returns:
the id of this group

getTitle

public String getTitle()
Returns the title of this group.

Returns:
The title of this group

getOwner

public String getOwner()
Returns the owner of this group.

Returns:
The owner of this group

getDescription

public String getDescription()
Returns the description of this group.

Returns:
The description of this group

getSnippet

public String getSnippet()
Returns a description snippet for this group.

Returns:
A description snippet for this group

getTags

public List<String> getTags()
Returns a list of tags associated with this group.

Returns:
A list of tags associated with this group

getThumbnailFileName

public String getThumbnailFileName()
Returns the filename of the thumbnail of this group.

Returns:
The filename of the thumbnail of this group

getThumbnail

public byte[] getThumbnail()
Returns the thumbnail of this group.

Returns:
The thumbnail of this group

getCreated

public long getCreated()
Returns the date on which this group was created.

Returns:
The date on which this group was created

getModified

public long getModified()
Returns the last date on which this group was modified.

Returns:
The last date on which this group was modified

isInvitationOnly

public boolean isInvitationOnly()
Returns whether or not this group requires an invitation to join.

Returns:
Whether or not this group requires an invitation to join

getAccess

public PortalAccess getAccess()
Returns the access level of this group.

Returns:
The access level of this group

getUsers

public List<String> getUsers()
Returns the users that belong to this group. Will be null until fetchUsers(PortalListener) is called (and fires the onCallback method successfully).

Returns:
The users that belong to this group

getAdmins

public List<String> getAdmins()
Returns the admins of this group. Will be null until fetchUsers(PortalListener) is called (and fires the onCallback method successfully).

Returns:
The admins of this group

hashCode

public int hashCode()

Overrides:
hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:
equals in class Object

toString

public String toString()

Overrides:
toString in class Object


Copyright © 2012. All Rights Reserved.