com.ibm.portal.cp.xml
Interface Constants

public interface Constants

Defines constants for contextual portal related REST services

Since:

7.0.0

Field Summary

static java.util.List<java.lang.String>	LIST_PREFIX_ALL Convenience object.
static java.lang.String	PARAM_COLLABORATIVE_SCOPE Parameter to specify certain collaborative scopes out of CollaborativeResource.Scope
static java.lang.String	PARAM_CONNECTIVE Parameter for the connective
static java.lang.String	PARAM_LOCALE Parameter to specify certain locales
static java.lang.String	PARAM_PREFIX Parameter for the prefixes
static java.lang.String	PARAM_RATING_MODEL_MODE Optional parameter to specify the rating model mode.
static java.lang.String	PARAM_RATING_MODEL_SCOPE the parameter specifying the rating model scope in which to search
static java.lang.String	PARAM_REP_MODE Parameter for the representation mode
static java.lang.String	PARAM_RESOURCE_MODEL_MODE Optional parameter to specify the resource model mode.
static java.lang.String	PARAM_RESOURCE_MODEL_SCOPE the parameter specifying the resource model scope in which to search for tags
static java.lang.String	PARAM_SCOPE Parameter for the scope of requested tag spaces or rating spaces.
static java.lang.String	PARAM_SEARCH_PATTERN Parameter for the search pattern
static java.lang.String	PARAM_TAG_MODEL_MODE Optional parameter to specify the tag model mode.
static java.lang.String	PARAM_TAG_MODEL_SCOPE the parameter specifying the tag model scope in which to search
static java.lang.String	PARAM_USER_MODEL_MODE Optional parameter to specify the user model mode.
static java.lang.String	PARAM_USER_MODEL_SCOPE the parameter specifying the user model scope in which to search
static java.lang.String	PARAM_VALUE_MODE_EXTEND Mode parameter value for extending.
static java.lang.String	PARAM_VALUE_MODE_SHRINK Mode parameter value for shrinking.
static java.lang.String	VALUE_PREFIX_ALL Value for PARAM_PREFIX.
static java.lang.String	VALUE_SCOPE_ALL Value for PARAM_SCOPE.
static java.lang.String	VALUE_SCOPE_COMMUNITY Value for PARAM_SCOPE.
static java.lang.String	VALUE_SCOPE_PERSONAL Value for PARAM_SCOPE.
static java.lang.String	VALUE_SCOPE_PERSONAL_PRIVATE Value for PARAM_SCOPE.
static java.lang.String	VALUE_SCOPE_PERSONAL_PUBLIC Value for PARAM_SCOPE.

Field Detail

PARAM_VALUE_MODE_EXTEND

static final java.lang.String PARAM_VALUE_MODE_EXTEND

Mode parameter value for extending.

See Also:

Constant Field Values

PARAM_VALUE_MODE_SHRINK

static final java.lang.String PARAM_VALUE_MODE_SHRINK

Mode parameter value for shrinking.

See Also:

Constant Field Values

PARAM_RESOURCE_MODEL_SCOPE

static final java.lang.String PARAM_RESOURCE_MODEL_SCOPE

the parameter specifying the resource model scope in which to search for tags

See Also:

Constant Field Values

PARAM_RESOURCE_MODEL_MODE

static final java.lang.String PARAM_RESOURCE_MODEL_MODE

Optional parameter to specify the resource model mode. Use PARAM_VALUE_MODE_EXTEND and PARAM_VALUE_MODE_SHRINK.

See Also:

Constant Field Values

PARAM_USER_MODEL_SCOPE

static final java.lang.String PARAM_USER_MODEL_SCOPE

the parameter specifying the user model scope in which to search

See Also:

Constant Field Values

PARAM_USER_MODEL_MODE

static final java.lang.String PARAM_USER_MODEL_MODE

Optional parameter to specify the user model mode. Use PARAM_VALUE_MODE_EXTEND and PARAM_VALUE_MODE_SHRINK.

See Also:

Constant Field Values

PARAM_TAG_MODEL_SCOPE

static final java.lang.String PARAM_TAG_MODEL_SCOPE

the parameter specifying the tag model scope in which to search

See Also:

Constant Field Values

PARAM_TAG_MODEL_MODE

static final java.lang.String PARAM_TAG_MODEL_MODE

Optional parameter to specify the tag model mode. Use PARAM_VALUE_MODE_EXTEND and PARAM_VALUE_MODE_SHRINK.

See Also:

Constant Field Values

PARAM_RATING_MODEL_SCOPE

static final java.lang.String PARAM_RATING_MODEL_SCOPE

the parameter specifying the rating model scope in which to search

See Also:

Constant Field Values

PARAM_RATING_MODEL_MODE

static final java.lang.String PARAM_RATING_MODEL_MODE

Optional parameter to specify the rating model mode. Use PARAM_VALUE_MODE_EXTEND and PARAM_VALUE_MODE_SHRINK.

See Also:

Constant Field Values

PARAM_LOCALE

static final java.lang.String PARAM_LOCALE

Parameter to specify certain locales

See Also:

Constant Field Values

PARAM_COLLABORATIVE_SCOPE

static final java.lang.String PARAM_COLLABORATIVE_SCOPE

Parameter to specify certain collaborative scopes out of CollaborativeResource.Scope

See Also:

Constant Field Values

PARAM_REP_MODE

static final java.lang.String PARAM_REP_MODE

Parameter for the representation mode

PARAM_SEARCH_PATTERN

static final java.lang.String PARAM_SEARCH_PATTERN

Parameter for the search pattern

See Also:

Constants.SearchPattern, Constant Field Values

PARAM_SCOPE

static final java.lang.String PARAM_SCOPE

Parameter for the scope of requested tag spaces or rating spaces. Possible values are:

1. VALUE_SCOPE_COMMUNITY
2. VALUE_SCOPE_PERSONAL_PRIVATE
3. VALUE_SCOPE_PERSONAL_PUBLIC
4. VALUE_SCOPE_PERSONAL
5. VALUE_SCOPE_ALL

Additionally the following combinations are supported:

1. VALUE_SCOPE_COMMUNITY and VALUE_SCOPE_PERSONAL_PUBLIC
2. VALUE_SCOPE_COMMUNITY and VALUE_SCOPE_PERSONAL_PRIVATE

See Also:

Constant Field Values

VALUE_SCOPE_COMMUNITY

static final java.lang.String VALUE_SCOPE_COMMUNITY

Value for PARAM_SCOPE. Community tags are all public tags of the community. The Community rating is the rating average of the community's public ratings. The public tags or ratings of the current user are not part of this set.

See Also:

Constant Field Values

VALUE_SCOPE_PERSONAL_PRIVATE

static final java.lang.String VALUE_SCOPE_PERSONAL_PRIVATE

Value for PARAM_SCOPE. Personal private tags are the private tags of the current user respectively the private rating of the current user.

See Also:

Constant Field Values

VALUE_SCOPE_PERSONAL_PUBLIC

static final java.lang.String VALUE_SCOPE_PERSONAL_PUBLIC

Value for PARAM_SCOPE. Personal public tags are the public tags of the current user respectively the public rating of the current user.

See Also:

Constant Field Values

VALUE_SCOPE_PERSONAL

static final java.lang.String VALUE_SCOPE_PERSONAL

Value for PARAM_SCOPE. This is the combination of VALUE_SCOPE_PERSONAL_PRIVATE and VALUE_SCOPE_PERSONAL_PUBLIC, i. e. this addresses all tags or ratings of the current user, including public and private tags / ratings.

See Also:

Constant Field Values

VALUE_SCOPE_ALL

static final java.lang.String VALUE_SCOPE_ALL

Value for PARAM_SCOPE. This is the combination of VALUE_SCOPE_COMMUNITY and VALUE_SCOPE_PERSONAL, i. e. this addresses all tags or ratings, including the private and public tags / ratings of the current user.

See Also:

Constant Field Values

PARAM_PREFIX

static final java.lang.String PARAM_PREFIX

Parameter for the prefixes

See Also:

Constant Field Values

VALUE_PREFIX_ALL

static final java.lang.String VALUE_PREFIX_ALL

Value for PARAM_PREFIX. If this value is specified all tags with all prefixes are being returned (no filtering).

See Also:

Constant Field Values

LIST_PREFIX_ALL

static final java.util.List<java.lang.String> LIST_PREFIX_ALL

Convenience object.

PARAM_CONNECTIVE

static final java.lang.String PARAM_CONNECTIVE

Parameter for the connective

See Also:

Constant Field Values