01: /*
02: * Copyright 2004 Outerthought bvba and Schaubroeck nv
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License.
15: */
16: package org.outerj.daisy.repository;
17:
18: import org.outerj.daisy.repository.variant.Branch;
19: import org.outerj.daisy.repository.variant.Language;
20: import org.outerx.daisy.x10.AvailableVariantDocument;
21:
22: /**
23: * Holds information about a variant of a document.
24: */
25: public interface AvailableVariant {
26: Branch getBranch() throws RepositoryException;
27:
28: Language getLanguage() throws RepositoryException;
29:
30: long getBranchId();
31:
32: long getLanguageId();
33:
34: boolean isRetired();
35:
36: /**
37: * Returns the ID of the live version of this document variant, or -1
38: * if this variant has no live version.
39: */
40: long getLiveVersionId();
41:
42: AvailableVariantDocument getXml();
43:
44: AvailableVariantDocument getXml(boolean includeVariantNames)
45: throws RepositoryException;
46: }
|