ccc.client.core
Interface Globals

All Known Implementing Classes:
GlobalsImpl

public interface Globals

API for creating application scope objects.

Author:
Civic Computing Ltd.

Field Summary
static java.lang.String API_URL
          API_URL : String.
static java.lang.String APP_URL
          APP_URL : String.
static int DEFAULT_HEIGHT
          DEFAULT_HEIGHT : int.
static int DEFAULT_MIN_HEIGHT
          DEFAULT_MIN_HEIGHT : int.
static int DEFAULT_UPLOAD_HEIGHT
          DEFAULT_UPLOAD_HEIGHT : int.
static int DEFAULT_WIDTH
          DEFAULT_WIDTH : int.
static int MAX_FETCH
          MAX_FETCH : int.
static int MIN_USER_NAME_LENGTH
          MIN_USER_NAME_LENGTH : int.
static int MIN_WIDTH
          MIN_WIDTH : int.
 
Method Summary
 PagedCollection<ActionSummary> actions()
          TODO: Add a description for this method.
 java.lang.String appURL()
          Determine the URL for the application.
 PagedCollection<Comment> comments()
          TODO: Add a description for this method.
 User currentUser()
          Accessor.
 void currentUser(User user)
          Mutator.
 java.lang.String getSetting(java.lang.String settingName)
          Retrieve a setting value.
 PagedCollection<Group> groups()
          TODO: Add a description for this method.
 java.lang.String hostURL()
          Determine the URL for the application's host.
 PagedCollection<User> users()
          TODO: Add a description for this method.
 

Field Detail

DEFAULT_WIDTH

static final int DEFAULT_WIDTH
DEFAULT_WIDTH : int.

See Also:
Constant Field Values

MIN_WIDTH

static final int MIN_WIDTH
MIN_WIDTH : int.

See Also:
Constant Field Values

DEFAULT_HEIGHT

static final int DEFAULT_HEIGHT
DEFAULT_HEIGHT : int.

See Also:
Constant Field Values

DEFAULT_UPLOAD_HEIGHT

static final int DEFAULT_UPLOAD_HEIGHT
DEFAULT_UPLOAD_HEIGHT : int.

See Also:
Constant Field Values

DEFAULT_MIN_HEIGHT

static final int DEFAULT_MIN_HEIGHT
DEFAULT_MIN_HEIGHT : int.

See Also:
Constant Field Values

APP_URL

static final java.lang.String APP_URL
APP_URL : String.

See Also:
Constant Field Values

API_URL

static final java.lang.String API_URL
API_URL : String.

See Also:
Constant Field Values

MIN_USER_NAME_LENGTH

static final int MIN_USER_NAME_LENGTH
MIN_USER_NAME_LENGTH : int.

See Also:
Constant Field Values

MAX_FETCH

static final int MAX_FETCH
MAX_FETCH : int.

See Also:
Constant Field Values
Method Detail

hostURL

java.lang.String hostURL()
Determine the URL for the application's host.

Returns:
The host url as a string.

appURL

java.lang.String appURL()
Determine the URL for the application.

Returns:
The host url as a string.

currentUser

User currentUser()
Accessor.

Returns:
The current logged in user.

currentUser

void currentUser(User user)
Mutator.

Parameters:
user - The current logged in user.

getSetting

java.lang.String getSetting(java.lang.String settingName)
Retrieve a setting value.

Parameters:
settingName - The name of the setting to retrieve.
Returns:
The value of the setting as a string or NULL, if the setting doesn't exist.

users

PagedCollection<User> users()
TODO: Add a description for this method.

Returns:

actions

PagedCollection<ActionSummary> actions()
TODO: Add a description for this method.

Returns:

comments

PagedCollection<Comment> comments()
TODO: Add a description for this method.

Returns:

groups

PagedCollection<Group> groups()
TODO: Add a description for this method.

Returns:


Copyright © 2010. All Rights Reserved.