Author: shane.bryzak(a)jboss.com Date: 2010-06-15 06:38:47 -0400 (Tue, 15 Jun 2010) New Revision: 304 Modified: idm/trunk/picketlink-idm-spi/src/main/java/org/picketlink/idm/spi/configuration/metadata/RelationshipMetaData.java Log: added javadoc Modified: idm/trunk/picketlink-idm-spi/src/main/java/org/picketlink/idm/spi/configuration/metadata/RelationshipMetaData.java =================================================================== --- idm/trunk/picketlink-idm-spi/src/main/java/org/picketlink/idm/spi/configuration/metadata/RelationshipMetaData.java 2010-06-11 20:06:20 UTC (rev 303) +++ idm/trunk/picketlink-idm-spi/src/main/java/org/picketlink/idm/spi/configuration/metadata/RelationshipMetaData.java 2010-06-15 10:38:47 UTC (rev 304) @@ -23,7 +23,10 @@ package org.picketlink.idm.spi.configuration.metadata; /** - * Relationship meta data + * Relationship meta data, used to represent a single allowed relationship type. + * + * This metadata is used by the configuration to define a set of allowable + * relationship types for a single identity store. * * @author <a href="mailto:boleslaw.dawidowicz at redhat.com">Boleslaw Dawidowicz</a> * @version : 0.1 $ @@ -31,11 +34,16 @@ public interface RelationshipMetaData { /** + * Returns the name of the relationship type, e.g. MEMBER_OF, ROLE, etc + * * @return RelationshipType name */ String getRelationshipTypeRef(); /** + * Returns the name of the allowed identity object type on the "to" side of + * the relationship, e.g. ORGANIZATION, GROUP. + * * @return IdentityObjectType name */ String getIdentityObjectTypeRef();