com.axemble.vdoc.sdk.interfaces

Interface ISsoDomainParameter

All Superinterfaces:

IDeletionSupport, IElement, IProtocolSupport, Serializable

public interface ISsoDomainParameter
extends IElement, IProtocolSupport, IDeletionSupport

This interface represents a sso domain parameter.

Author:

ploureiro

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASIC_LOGIN_PARAM
static String	BASIC_PASSWORD_PARAM
static String	URL_PARAM

Method Summary

Modifier and Type	Method and Description
String	getDefaultValue()
String	getDescription()
String	getLabel()
String	getName()
ISsoDomain	getSsoDomain() Gets the domain object.
String	getValue(IContext context) get the user parameter for this domain parameter
boolean	isAllowOverride()
void	setAllowOverride(boolean allowOverride) Sets if the domain parameter can be modified by the users
void	setDefaultValue(String defaultValue) Sets the default value of the domain parameter.
void	setDescription(String description) Sets the description of the domain.
void	setLabel(String label) Sets the label of the domain.
void	setValue(IContext context, String value) Set the user parameter

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.IElement

getId, getModule, getNativeObject, getPath, save

Methods inherited from interface com.axemble.vdoc.sdk.supports.IProtocolSupport

getProtocolURI, getProtocolURI

Methods inherited from interface com.axemble.vdoc.sdk.supports.IDeletionSupport

delete

Field Detail

URL_PARAM

static final String URL_PARAM

See Also:

Constant Field Values

BASIC_LOGIN_PARAM

static final String BASIC_LOGIN_PARAM

See Also:

Constant Field Values

BASIC_PASSWORD_PARAM

static final String BASIC_PASSWORD_PARAM

See Also:

Constant Field Values

Method Detail

getLabel

String getLabel()

Returns:

the label of the domain.

setLabel

void setLabel(String label)

Sets the label of the domain.

Parameters:

label - the new label to set.

getDescription

String getDescription()

Returns:

the description of the domain.

setDescription

void setDescription(String description)

Sets the description of the domain.

Parameters:

description - the new description to set.

getName

String getName()

Returns:

the name of the domain parameter.

getDefaultValue

String getDefaultValue()

Returns:

the default value of the domain parameter.

setDefaultValue

void setDefaultValue(String defaultValue)

Sets the default value of the domain parameter.

Parameters:

defaultValue - the default value to set.

isAllowOverride

boolean isAllowOverride()

Returns:

true if the domain parameter can be modified by the users false otherwise.

setAllowOverride

void setAllowOverride(boolean allowOverride)

Sets if the domain parameter can be modified by the users

Parameters:

allowOverride - to set.

getSsoDomain

ISsoDomain getSsoDomain()

Gets the domain object.

Returns:

A ISsoDomain object.

setValue

void setValue(IContext context,
              String value)

Set the user parameter

Parameters:

context - user context

value - value to set

getValue

String getValue(IContext context)

get the user parameter for this domain parameter

Parameters:

context - user context

Returns:

String the user parameter value for this domain parameter