Package lumis.portal.monitor.impl

Class MonitorFieldGroup

java.lang.Object

lumis.portal.monitor.impl.MonitorFieldGroup

All Implemented Interfaces:

IMonitorElementSPI<IMonitorFieldGroupSPI>, IMonitorFieldGroup, IMonitorFieldGroupSPI

public class MonitorFieldGroup
extends java.lang.Object
implements IMonitorFieldGroupSPI

Field group.

Since:

11.0.0

Version:

$Revision$ $Date$

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	id

Constructor Summary

Constructors

Constructor	Description
MonitorFieldGroup(java.lang.String id, java.lang.String serviceInstanceId)	Creates a new field group.

Method Summary

Modifier and Type	Method	Description
IMonitorFieldGroupSPI	addField(IMonitorFieldSPI field)	Adds the given field in this field group.
java.util.Collection<IMonitorField>	getFields()	Returns the fields of this field group.
java.lang.String	getId()	Returns the identifier of this element.
java.lang.String	getServiceInstanceId()	Returns the identifier of the service instance this element belongs to.
IMonitorFieldGroupSPI	removeField(java.lang.String fieldId)	Removes the given field.
IMonitorFieldGroupSPI	removeFields(java.util.Collection<java.lang.String> fieldsIds)	Removes the direct fields that has their ids in the given ids collection.
IMonitorFieldGroupSPI	setStandard(boolean isStandard)	Sets this field group either as standard or custom (non-standard).
protected void	validateLocalId(java.lang.String localId)	Validates the part of the identifier without the service instance identifier prefix, when the element belongs to a service instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface lumis.portal.monitor.IMonitorElementSPI

getServiceInstanceId

Field Detail

id

protected java.lang.String id

Constructor Detail

MonitorFieldGroup

public MonitorFieldGroup(java.lang.String id,
                         java.lang.String serviceInstanceId)
                  throws PortalException

Creates a new field group.

Parameters:

id - the field group identifier.

serviceInstanceId - the identifier of the service instance the group belongs to, or null if it is a global group.

Throws:

PortalException

Since:

14.0.0

Method Detail

getId

public java.lang.String getId()

Returns the identifier of this element.

Specified by:

getId in interface IMonitorElementSPI<IMonitorFieldGroupSPI>

Specified by:

getId in interface IMonitorFieldGroup

Returns:

the identifier.

getFields

public java.util.Collection<IMonitorField> getFields()

Description copied from interface: IMonitorFieldGroup

Returns the fields of this field group.

Specified by:

getFields in interface IMonitorFieldGroup

Returns:

the fields of this field group.

removeFields

public IMonitorFieldGroupSPI removeFields(java.util.Collection<java.lang.String> fieldsIds)

Removes the direct fields that has their ids in the given ids collection.

Parameters:

fieldsIds - the identifiers of the fields to be removed

Returns:

this field group for chaining

Since:

14.0.0

addField

public IMonitorFieldGroupSPI addField(IMonitorFieldSPI field)

Description copied from interface: IMonitorFieldGroupSPI

Adds the given field in this field group.

Specified by:

addField in interface IMonitorFieldGroupSPI

Parameters:

field - the field.

Returns:

this field group for chaining.

removeField

public IMonitorFieldGroupSPI removeField(java.lang.String fieldId)

Description copied from interface: IMonitorFieldGroupSPI

Removes the given field.

Specified by:

removeField in interface IMonitorFieldGroupSPI

Parameters:

fieldId - the field identifier.

Returns:

this field group.

setStandard

public IMonitorFieldGroupSPI setStandard(boolean isStandard)

Description copied from interface: IMonitorFieldGroupSPI

Sets this field group either as standard or custom (non-standard).

Specified by:

setStandard in interface IMonitorFieldGroupSPI

Parameters:

isStandard - true to mark this field group as standard, false to custom.

Returns:

this field group for chaining.

validateLocalId

protected void validateLocalId(java.lang.String localId)
                        throws PortalException

Validates the part of the identifier without the service instance identifier prefix, when the element belongs to a service instance.

Parameters:

localId - the part of the identifier without the service instance identifier prefix.

Throws:

PortalException - if the validation fails.

Since:

14.0.0

getServiceInstanceId

public java.lang.String getServiceInstanceId()

Returns the identifier of the service instance this element belongs to.

Returns:

the identifier of the service instance this element belongs to or null if this element is global.

Since:

14.0.0