org.picketlink.idm.model.Relationship Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of picketlink-idm-api
The newest version!
/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2012, Red Hat, Inc., and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.picketlink.idm.model;

import java.io.Serializable;

import org.picketlink.idm.query.QueryParameter;

/**
 * Represents a relationship between two or more {@link IdentityType}
 * @author anil saldhana
 * @since Dec 18, 2012
 */
public interface Relationship extends IdentityType, Serializable {
    /**
     * A query parameter used to set the id value.
     */
    QueryParameter ID = new QueryParameter() {};

    /**
     * A query parameter used to set the name value.
     */
    QueryParameter NAME = new QueryParameter() {};

    /**
     * A query parameter used to set the owner side of the relationship.
     */
    QueryParameter TO = new QueryParameter() {};

    /**
     * A query parameter used to set the other side of the relationship.
     */
    QueryParameter FROM = new QueryParameter() {};

    String KEY_PREFIX = "REL://";

    /**
     * @return Relationship Id in String representation.
     */
    String getId();

    /**
     * Relationship name is unique identifier in specific group tree branch. For example group with id "/acme/departments/marketing"
     * will have name "marketing" and parent group of id "/acme/departments"
     *
     * @return name
     */
    String getName();
    
    /**
     * Get the {@link IdentityType} from where the relationship originates
     * @return
     */
    IdentityType from();
    
    /**
     * Get the {@link IdentityType} to where the relationship ends
     * @return
     */
    IdentityType to();
    
    /**
     * Sets the {@link IdentityType} from where the relationship originates
     * @return
     */
    void setFrom(IdentityType from);
    
    /**
     * Sets the {@link IdentityType} to where the relationship ends
     * @return
     */
    void setTo(IdentityType to);
}