edu.ucdavis.cstars.client.arcgis

Class PortalGroup

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.arcgis.PortalGroup

public class PortalGroup
extends com.google.gwt.core.client.JavaScriptObject

Execute a query against the Portal to return a deferred that when resolved returns PortalQueryResult that contain a results array of PortalGroup ojbects for all the groups that match the input query.

Author:

Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PortalGroup.Access

Method Summary

Methods

Modifier and Type	Method and Description
PortalGroup.Access	getAccess() The access privileges on the group which determines who can see and access the group.
com.google.gwt.core.client.JsDate	getCreated() The date the group was created.
java.lang.String	getDescription() A detailed description of the group.
java.lang.String	getId() The id for the group.
Deferred	getMembers(PortalGroupMembersCallback callback) Get the current members for the group.
com.google.gwt.core.client.JsDate	getModified() The date the group was last modified.
java.lang.String	getOwner() The username of the group's owner.
Portal	getPortal() The portal for the group.
java.lang.String	getSnippet() A short summary that describes the group.
com.google.gwt.core.client.JsArrayString	getTags() User defined tags that describe the group.
java.lang.String	getThumbnailUrl() The url to the thumbnail used for the group.
java.lang.String	getTitle() The title for the group.
java.lang.String	getUrl() The url to the group.
boolean	isInvitationOnly() If this is set to true, then users will not be able to apply to join the group.
Deferred	queryItem(PortalQueryParams queryParams, PortalQueryItemsCallback callback) Execute a query against the group to return a deferred that when resolved returns PortalQueryResults that contain a results array of PortalItem objects that match the input query.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getAccess

public final PortalGroup.Access getAccess()

The access privileges on the group which determines who can see and access the group. Can be: private, org, or public.

Returns:

Access

getCreated

public final com.google.gwt.core.client.JsDate getCreated()

The date the group was created.

Returns:

JsDate

getDescription

public final java.lang.String getDescription()

A detailed description of the group.

Returns:

String

getId

public final java.lang.String getId()

The id for the group.

Returns:

String

isInvitationOnly

public final boolean isInvitationOnly()

If this is set to true, then users will not be able to apply to join the group.

Returns:

boolean

getModified

public final com.google.gwt.core.client.JsDate getModified()

The date the group was last modified.

Returns:

JsDate

getOwner

public final java.lang.String getOwner()

The username of the group's owner.

Returns:

String

getPortal

public final Portal getPortal()

The portal for the group.

Returns:

Portal

getSnippet

public final java.lang.String getSnippet()

A short summary that describes the group.

Returns:

String

getTags

public final com.google.gwt.core.client.JsArrayString getTags()

User defined tags that describe the group.

Returns:

JsArrayString

getThumbnailUrl

public final java.lang.String getThumbnailUrl()

The url to the thumbnail used for the group.

Returns:

String

getTitle

public final java.lang.String getTitle()

The title for the group. This is the name that is displayed to users and by which they refer to the group. Every group must have a title and it must be unique for a user.

Returns:

String

getUrl

public final java.lang.String getUrl()

The url to the group.

Returns:

getMembers

public final Deferred getMembers(PortalGroupMembersCallback callback)

Get the current members for the group. Returns a deferred that when resolved provides access to a PortalGroupMembers object.

Parameters:

callback - - handler to fire when members are returned

Returns:

Deferred

queryItem

public final Deferred queryItem(PortalQueryParams queryParams,
                 PortalQueryItemsCallback callback)

Execute a query against the group to return a deferred that when resolved returns PortalQueryResults that contain a results array of PortalItem objects that match the input query.

Parameters:

queryParams - - The input query parameters.

callback - - function to fire when query completes

Returns:

Deferred