com.esri.core.portal
Class PortalInfo

java.lang.Object
  com.esri.core.portal.PortalInfo

public class PortalInfo
extends Object

Class used to hold some information about the Portal such as default basemap, featured groups, etc. If the user is not logged in this call will return some defaults. If the user is logged in, the account information returned will be specific to the user's account.

Method Summary

boolean	equals(Object obj)
void	fetchOrganizationThumbnail(PortalListener<byte[]> portalListener) Fetches the organization thumbnail from the portal.
void	fetchPortalThumbnail(PortalListener<byte[]> portalListener) Fetches the portal thumbnail from the portal.
static PortalInfo	fromJson(org.codehaus.jackson.JsonParser parser, Portal portal)
PortalAccess	getAccess() Returns the access level of the Portal or Organization.
String	getBasemapGalleryGroupQuery() Returns the query used to determine which group should drive the gallery of basemaps displayed in the client application for the specified culture.
BaseMap	getDefaultBaseMap() Returns the default basemap to be used by the client application for the specified culture when creating new maps (if applicable).
MapGeometry	getDefaultExtent() Returns the default extent to be used by the client application for the specified culture when creating new maps (if applicable).
List<String>	getFeaturedGroupsQueries() Returns an array of featured groups to possibly display on the group page or to feature for an organization.
String	getFeaturedItemsGroupQuery() Returns the query used to determine which group should drive the gallery of featured items displayed in the client application for the specified culture.
String	getHomepageFeaturedContentGroupQuery() Returns the pre-defined query string for finding homepage featured items group on the portal.
String	getOrganizationDescription() Returns the description of the organization.
String	getOrganizationId() Returns the id of the organization, if the user belongs to one.
String	getOrganizationName() Returns the name of the organization.
byte[]	getOrganizationThumbnail() Returns the organization's thumbnail.
String	getOrganizationThumbnailFileName() Returns the filename for the organization's thumbnail.
Portal	getPortal() Returns the Portal from which this PortalInfo was generated.
PortalMode	getPortalMode() Returns the tenancy mode of the Portal.
String	getPortalName() Returns the name of the Portal.
byte[]	getPortalThumbnail() Returns the portal's thumbnail.
String	getPortalThumbnailFileName() Returns the filename for the portal's thumbnail.
int	hashCode()
boolean	isCanSharePublic() Returns whether or not users in the organization can share with the public.
boolean	isShowHomePageDescription() Returns whether or not the organization's description should be shown.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

fetchOrganizationThumbnail

public void fetchOrganizationThumbnail(PortalListener<byte[]> portalListener)

Fetches the organization thumbnail from the portal. Implement the callback listener to receieve the thumbnails and check for errors.

Parameters:

portalListener - - fetches the thumbnail associated with an organization as a byte array.

fetchPortalThumbnail

public void fetchPortalThumbnail(PortalListener<byte[]> portalListener)

Fetches the portal thumbnail from the portal. Implement the callback listener to receieve the thumbnails and check for errors.

Parameters:

portalListener - fetches the thumbnail associated with a portal as a byte array.

fromJson

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

Throws:

Exception

getPortal

public Portal getPortal()

Returns the Portal from which this PortalInfo was generated.

Returns:

The Portal from which this PortalInfo was generated

getPortalThumbnail

public byte[] getPortalThumbnail()

Returns the portal's thumbnail. Will be null if no thumbnail is set.

Returns:

The portal's thumbnail

getOrganizationThumbnail

public byte[] getOrganizationThumbnail()

Returns the organization's thumbnail. Will be null if no thumbnail is set.

Returns:

The organization's thumbnail

getBasemapGalleryGroupQuery

public String getBasemapGalleryGroupQuery()

Returns the query used to determine which group should drive the gallery of basemaps displayed in the client application for the specified culture.

Returns:

The query used to determine which group should drive the gallery of basemaps displayed in the client application for the specified culture

getHomepageFeaturedContentGroupQuery

public String getHomepageFeaturedContentGroupQuery()

Returns the pre-defined query string for finding homepage featured items group on the portal.

Returns:

The pre-defined query string for finding homepage featured items group on the portal

getDefaultBaseMap

public BaseMap getDefaultBaseMap()

Returns the default basemap to be used by the client application for the specified culture when creating new maps (if applicable).

Returns:

The default basemap to be used by the client application for the specified culture when creating new maps (if applicable)

getDefaultExtent

public MapGeometry getDefaultExtent()

Returns the default extent to be used by the client application for the specified culture when creating new maps (if applicable).

Returns:

The default extent to be used by the client application for the specified culture when creating new maps (if applicable)

getOrganizationDescription

public String getOrganizationDescription()

Returns the description of the organization. In the case of non-organizational users of ArcGIS Online or a multi-tenant portal, this will be null.

Returns:

The description of the organization. In the case of non-organizational users of ArcGIS Online or a multi-tenant portal, this will be null

getFeaturedGroupsQueries

public List<String> getFeaturedGroupsQueries()

Returns an array of featured groups to possibly display on the group page or to feature for an organization. This is an array of title and owner which can be used to search for these groups or setup links to them.

Returns:

An array of featured groups to possibly display on the group page or to feature for an organization

getFeaturedItemsGroupQuery

public String getFeaturedItemsGroupQuery()

Returns the query used to determine which group should drive the gallery of featured items displayed in the client application for the specified culture.

Returns:

The query used to determine which group should drive the gallery of featured items displayed in the client application for the specified culture

getOrganizationId

public String getOrganizationId()

Returns the id of the organization, if the user belongs to one.

Returns:

The id of the organization, if the user belongs to one

getOrganizationName

public String getOrganizationName()

Returns the name of the organization. In the case of non-organizational users of ArcGIS Online or a multi-tenant portal this will be null.

Returns:

The name of the organization

getPortalName

public String getPortalName()

Returns the name of the Portal.

Returns:

The name of the portal

getPortalThumbnailFileName

public String getPortalThumbnailFileName()

Returns the filename for the portal's thumbnail. Will be null if no thumbnail is set.

Returns:

The filename for the portal's thumbnail

isShowHomePageDescription

public boolean isShowHomePageDescription()

Returns whether or not the organization's description should be shown.

Returns:

Whether or not the organization's description should be shown

getOrganizationThumbnailFileName

public String getOrganizationThumbnailFileName()

Returns the filename for the organization's thumbnail. Will be null if no thumbnail is set.

Returns:

The filename for the organization's thumbnail

isCanSharePublic

public boolean isCanSharePublic()

Returns whether or not users in the organization can share with the public.

Returns:

Whether or not the organization's description should be shown

getAccess

public PortalAccess getAccess()

Returns the access level of the Portal or Organization.

Returns:

The access level of the Portal or Organization

getPortalMode

public PortalMode getPortalMode()

Returns the tenancy mode of the Portal.

Returns:

The tenancy mode of the Portal

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