001/*
002 * Copyright 2015 DuraSpace, Inc.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.fcrepo.migration;
017
018/**
019 * An interface defining access to information about a fedora datastream.
020 * @author mdurbin
021 */
022public interface DatastreamInfo {
023
024    /**
025     * Gets the information about the object to which this datastream
026     * belongs.
027     *
028     * @return {@link org.fcrepo.migration.ObjectInfo}
029     */
030    public ObjectInfo getObjectInfo();
031
032    /**
033     * Gets the identifier for this datastream (Unique within an object).
034     *
035     * @return datastream id
036     */
037    public String getDatastreamId();
038
039    /**
040     * Gets the control group for this datastream.  This is expected to be
041     * "M", "X", "R" or "E".
042     *
043     * @return control group
044     */
045    public String getControlGroup();
046
047    /**
048     * Gets the fedora URI for this datastream.
049     *
050     * @return Fedora URI
051     */
052    public String getFedoraURI();
053
054    /**
055     * Gets the state for this datastream.  This is expected to be "A", "I" or
056     * "D".
057     *
058     * @return  state
059     */
060    public String getState();
061
062    /**
063     * Returns true if this datastream was/is versionable.
064     *
065     * @return true if versionable
066     */
067    public boolean getVersionable();
068}