/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.chemistry.opencmis.client.api;

/**
 * CMIS relationship interface.
 * 
 * @cmis 1.0
 */
public interface Relationship extends CmisObject, RelationshipProperties {

    /**
     * Returns the object type as a relationship type.
     * 
     * @return the relationship type
     * 
     * @throws ClassCastException
     *             if the object type is not a relationship type
     * 
     * @cmis 1.0
     */
    RelationshipType getRelationshipType();

    /**
     * Gets the source object. If the source object ID is invalid, {@code null}
     * will be returned.
     * 
     * @cmis 1.0
     */
    CmisObject getSource();

    /**
     * Gets the source object using the given {@link OperationContext}. If the
     * source object ID is invalid, {@code null} will be returned.
     * 
     * @cmis 1.0
     */
    CmisObject getSource(OperationContext context);

    /**
     * Gets the target object. If the target object ID is invalid, {@code null}
     * will be returned.
     * 
     * @cmis 1.0
     */
    CmisObject getTarget();

    /**
     * Gets the target object using the given {@link OperationContext}. If the
     * target object ID is invalid, {@code null} will be returned.
     * 
     * @cmis 1.0
     */
    CmisObject getTarget(OperationContext context);
}