Package pl.edu.icm.unity.types

Interface DescribedObject

All Superinterfaces:

NamedObject

All Known Subinterfaces:

AttributeMetadataProvider, CredentialRetrievalFactory, CredentialVerificator, CredentialVerificatorFactory, LocalCredentialVerificator, LocalCredentialVerificatorFactory, TokenContentsJsonSerializer

All Known Implementing Classes:

AbstractCredentialRetrievalFactory, AbstractCredentialVerificatorFactory, AbstractLocalCredentialVerificatorFactory, AbstractLocalVerificator, AbstractRemoteVerificator, AbstractVerificator, AttributesClass, AuthenticationRealm, BaseForm, CredentialRequirements, CredentialType, DefaultJsonFormatterFacility, DescribedObjectImpl, DescribedObjectROImpl, EndpointTypeDescription, EnquiryForm, MessageTemplate, NotificationChannel, NotificationChannelInfo, RegistrationForm, TokenWithJsonContentsSerializer, TranslationProfile

public interface DescribedObject
extends NamedObject

General purpose interface, useful for extending. Defines methods to get object name and description. This version is useful for objects providing a fixed, implementation defined name and description. In future the description type should be changed to I18nString so that a localized value is returned, however the intention is that the description returned by this interface is aimed at admin only.

Author:

K. Benedyczak

Method Summary

Modifier and Type	Method	Description
String	getDescription()

Methods inherited from interface pl.edu.icm.unity.types.NamedObject

getName

Method Detail

getDescription

String getDescription()

Returns:

human readable description of the object.