FragmentProperty (Jetspeed-2 Core API 2.2.2 API)

This project has retired. For details please refer to its Attic page.

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.jetspeed.om.page
Interface FragmentProperty

public interface FragmentProperty

This interface represents a scoped fragment property.

Version:: $Id$
Author:: Randy Watler

Field Summary

static java.lang.String GLOBAL_PROPERTY_SCOPE
          global standard property scope

static boolean GROUP_AND_ROLE_PROPERTY_SCOPES_ENABLED
          group and role standard property scopes enabled flag

static java.lang.String GROUP_PROPERTY_SCOPE
          group standard property scope

static java.lang.String ROLE_PROPERTY_SCOPE
          role standard property scope

static java.lang.String USER_PROPERTY_SCOPE
          user standard property scope

Method Summary

java.lang.String getName()
          Get property name.

java.lang.String getScope()
          Get property scope.

java.lang.String getScopeValue()
          Get property scope discriminator value.

java.lang.String getValue()
          Get property value.

void setName(java.lang.String name)
          Set property name.

void setScope(java.lang.String scope)
          Set property scope.

void setScopeValue(java.lang.String value)
          Set property scope discriminator value.

void setValue(java.lang.String value)
          Set property value.

Field Summary
`static java.lang.String`	`GLOBAL_PROPERTY_SCOPE` global standard property scope
`static boolean`	`GROUP_AND_ROLE_PROPERTY_SCOPES_ENABLED` group and role standard property scopes enabled flag
`static java.lang.String`	`GROUP_PROPERTY_SCOPE` group standard property scope
`static java.lang.String`	`ROLE_PROPERTY_SCOPE` role standard property scope
`static java.lang.String`	`USER_PROPERTY_SCOPE` user standard property scope

Method Summary
`java.lang.String`	`getName()` Get property name.
`java.lang.String`	`getScope()` Get property scope.
`java.lang.String`	`getScopeValue()` Get property scope discriminator value.
`java.lang.String`	`getValue()` Get property value.
`void`	`setName(java.lang.String name)` Set property name.
`void`	`setScope(java.lang.String scope)` Set property scope.
`void`	`setScopeValue(java.lang.String value)` Set property scope discriminator value.
`void`	`setValue(java.lang.String value)` Set property value.

Field Detail

USER_PROPERTY_SCOPE

static final java.lang.String USER_PROPERTY_SCOPE

user standard property scope

See Also:: Constant Field Values

GROUP_PROPERTY_SCOPE

static final java.lang.String GROUP_PROPERTY_SCOPE

group standard property scope

See Also:: Constant Field Values

ROLE_PROPERTY_SCOPE

static final java.lang.String ROLE_PROPERTY_SCOPE

role standard property scope

See Also:: Constant Field Values

GLOBAL_PROPERTY_SCOPE

static final java.lang.String GLOBAL_PROPERTY_SCOPE

global standard property scope

GROUP_AND_ROLE_PROPERTY_SCOPES_ENABLED

static final boolean GROUP_AND_ROLE_PROPERTY_SCOPES_ENABLED

group and role standard property scopes enabled flag

See Also:: Constant Field Values

Method Detail

getName

java.lang.String getName()

Get property name.

Returns:: property name

setName

void setName(java.lang.String name)

Set property name.

Parameters:: name - property name

getScope

java.lang.String getScope()

Get property scope. Supported scopes are: GLOBAL or null, USER, GROUP, and ROLE.

Returns:: property scope

setScope

void setScope(java.lang.String scope)

Set property scope. Supported scopes are: GLOBAL or null, USER, GROUP, and ROLE.

Parameters:: scope - property scope

getScopeValue

java.lang.String getScopeValue()

Get property scope discriminator value.

Returns:: property scope

setScopeValue

void setScopeValue(java.lang.String value)

Set property scope discriminator value.

Parameters:: value - property scope discriminator

getValue

java.lang.String getValue()

Get property value.

Returns:: list of String preference values

setValue

void setValue(java.lang.String value)

Set property value.

Parameters:: value - property value