com.esri.core.internal.catalog
Class User

java.lang.Object
  com.esri.core.internal.catalog.User

All Implemented Interfaces:

PageableResultType

public class User
extends Object
implements PageableResultType

This class represents a registered User on arcgis.com. Personal details of the user, such as email and groups, are returned only to the user or the administrator of the user's organization.

Nested Class Summary

static class

User.SortField The fields of a User stored as a back-end database table on the server, that can be used to sort search results

Constructor Summary

protected

User() Creates an empty User.

Method Summary

<T extends PageableResultType> int	compare(T arg0) Internal method that all instances of a PageableResultType must implement.
boolean	fromJson(org.codehaus.jackson.JsonParser response, com.esri.core.internal.catalog.Filter filter, Catalog catalog) Sets the internal state of the User with values contained in the Json response.
List<String>	getClientApps() Returns the user's client application
Date	getCreated() Returns the creation Date of the user's profile.
Group	getDefaultGroup() Returns the user's default Group
String	getDescription() Returns the user's description
String	getEmail() Return the email address of the user
String	getFullName() Return the user's full name
List<Group>	getGroups() Returns all the groups that the user belongs to
Date	getModifiedDate() Returns the date that the user's profile was modified
String	getOrganization() Returns the organization the user belongs to
String	getPreferredView() Returns the user's preferred view
String	getPrivacy() Returns the privacy settings of the user
long	getStorageQuota() Returns the User's storage quota
long	getStorageUsage() Returns the User's storage usage
List<String>	getTags() Returns a list of search tags associated with this User
byte[]	getThumbnail() Returns a thumbnail for this user.
String	getUserName() Returns the user name

Methods inherited from class java.lang.Object

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

Constructor Detail

User

protected User()

Creates an empty User. Clients will never construct a User instance programmatically.

Method Detail

getUserName

public String getUserName()

Returns the user name

Returns:

the userName

getFullName

public String getFullName()

Return the user's full name

Returns:

the fullName

getPreferredView

public String getPreferredView()

Returns the user's preferred view

Returns:

the preferredView

getClientApps

public List<String> getClientApps()

Returns the user's client application

Returns:

the clientApps

getDefaultGroup

public Group getDefaultGroup()

Returns the user's default Group

Returns:

the defaultGroup

getDescription

public String getDescription()

Returns the user's description

Returns:

the description

getEmail

public String getEmail()

Return the email address of the user

Returns:

the email address

getPrivacy

public String getPrivacy()

Returns the privacy settings of the user

Returns:

the privacy

getOrganization

public String getOrganization()

Returns the organization the user belongs to

Returns:

the organization

getCreated

public Date getCreated()

Returns the creation Date of the user's profile.

Returns:

the creation Date

getGroups

public List<Group> getGroups()

Returns all the groups that the user belongs to

Returns:

the groups

getTags

public List<String> getTags()

Returns a list of search tags associated with this User

Returns:

the search tags

getStorageUsage

public long getStorageUsage()

Returns the User's storage usage

Returns:

the storage usage in bytes

getStorageQuota

public long getStorageQuota()

Returns the User's storage quota

Returns:

the storage quota in bytes

getThumbnail

public byte[] getThumbnail()

Returns a thumbnail for this user. The consuming application (Android/Java SE) can use platform specific APIs to construct an image out of the bytes returned.

Returns:

an array of the image bytes

getModifiedDate

public Date getModifiedDate()

Returns the date that the user's profile was modified

Returns:

the modified Date

fromJson

public boolean fromJson(org.codehaus.jackson.JsonParser response,
                        com.esri.core.internal.catalog.Filter filter,
                        Catalog catalog)

Sets the internal state of the User with values contained in the Json response.

Specified by:

fromJson in interface PageableResultType

Parameters:

response - the Json response

filter - a client side filter

catalog - reference to the Catalog

Returns:

true if this User qualifies to be returned to the client after the filter has been applied, else false

compare

public <T extends PageableResultType> int compare(T arg0)

Description copied from interface: PageableResultType

Internal method that all instances of a PageableResultType must implement.

Specified by:

compare in interface PageableResultType

Parameters:

arg0 - an instance of a PageableResultType

Returns:

-1 if this instance is less than arg0, 1 if it is greater, 0 if they are equal.