com.aspose.note.revision

Interfaces

Classes

com.aspose.note.revision

Class Header

    • Field Detail

      • GuidFileTypeDocument

        public static final Guid GuidFileTypeDocument

        File type GUID for OneNote Document

      • GuidFileTypeNotebook

        public static final Guid GuidFileTypeNotebook

        File type GUID for OneNote Notebook

      • GuidFileFormatOneNote2010

        public static final Guid GuidFileFormatOneNote2010

        File format GUID for OneNote 2010

      • GuidFileFormatOneNoteOnline

        public static final Guid GuidFileFormatOneNoteOnline

        File format GUID for OneNote Online

      • FfvOldestCodeThatMayReadThisFileForDocument

        public static final long FfvOldestCodeThatMayReadThisFileForDocument

        The oldest code for OneNote Document

        See Also:
        Constant Field Values
      • FfvOldestCodeThatMayReadThisFileForNotebook

        public static final long FfvOldestCodeThatMayReadThisFileForNotebook

        The oldest code for OneNote Notebook

        See Also:
        Constant Field Values
    • Constructor Detail

      • Header

        public Header()
    • Method Detail

      • getGuidFileType

        public Guid getGuidFileType()

        Gets or sets the type of OneNOde file

      • setGuidFileType

        public void setGuidFileType(Guid value)

        Gets or sets the type of OneNOde file

      • getGuidFile

        public Guid getGuidFile()

        Gets or sets a GUID, as specified by [MS-DTYP], that specifies the identity of this revision store file. SHOULD be globally unique.

      • setGuidFile

        public void setGuidFile(Guid value)

        Gets or sets a GUID, as specified by [MS-DTYP], that specifies the identity of this revision store file. SHOULD be globally unique.

      • getGuidLegacyFileVersion

        public Guid getGuidLegacyFileVersion()

        MUST be "{00000000-0000-0000-0000-000000000000}" and MUST be ignored.

      • setGuidLegacyFileVersion

        public void setGuidLegacyFileVersion(Guid value)

        MUST be "{00000000-0000-0000-0000-000000000000}" and MUST be ignored.

      • getGuidFileFormat

        public Guid getGuidFileFormat()

        Gets or sets a GUID, as specified by [MS-DTYP], that specifies that the file is a revision store file.

      • setGuidFileFormat

        public void setGuidFileFormat(Guid value)

        Gets or sets a GUID, as specified by [MS-DTYP], that specifies that the file is a revision store file.

      • getFfvLastCodeThatWroteToThisFile

        public long getFfvLastCodeThatWroteToThisFile()

        Gets or sets an unsigned integer. MUST be one of the values in the following table, depending on the file type .oNE -> 0x0000002A (42) .oNETOC2 -> 0x0000001B (27).

      • setFfvLastCodeThatWroteToThisFile

        public void setFfvLastCodeThatWroteToThisFile(long value)

        Gets or sets an unsigned integer. MUST be one of the values in the following table, depending on the file type .oNE -> 0x0000002A (42) .oNETOC2 -> 0x0000001B (27).

      • getFfvOldestCodeThatHasWrittenToThisFile

        public long getFfvOldestCodeThatHasWrittenToThisFile()

        Gets or sets an unsigned integer. MUST be one of the values in the following table, depending on the file format of this file .oNE -> 0x0000002A (42) .oNETOC2 -> 0x0000001B (27).

      • setFfvOldestCodeThatHasWrittenToThisFile

        public void setFfvOldestCodeThatHasWrittenToThisFile(long value)

        Gets or sets an unsigned integer. MUST be one of the values in the following table, depending on the file format of this file .oNE -> 0x0000002A (42) .oNETOC2 -> 0x0000001B (27).

      • getFfvNewestCodeThatHasWrittenToThisFile

        public long getFfvNewestCodeThatHasWrittenToThisFile()

        Gets or sets an unsigned integer. MUST be one of the values in the following table, depending on the file format of this file .oNE -> 0x0000002A (42) .oNETOC2 -> 0x0000001B (27).

      • setFfvNewestCodeThatHasWrittenToThisFile

        public void setFfvNewestCodeThatHasWrittenToThisFile(long value)

        Gets or sets an unsigned integer. MUST be one of the values in the following table, depending on the file format of this file .oNE -> 0x0000002A (42) .oNETOC2 -> 0x0000001B (27).

      • getFfvOldestCodeThatMayReadThisFile

        public long getFfvOldestCodeThatMayReadThisFile()

        Gets or sets an unsigned integer. MUST be one of the values in the following table, depending on the file format of this file If the value of the Header.FFVOldestCodeThatMayReadThisFile field is greater than 0x0000002A (42), programs that implement this structure specification ignore all other data in the file .oNE -> 0x0000002A (42) .oNETOC2 -> 0x0000001B (27).

      • setFfvOldestCodeThatMayReadThisFile

        public void setFfvOldestCodeThatMayReadThisFile(long value)

        Gets or sets an unsigned integer. MUST be one of the values in the following table, depending on the file format of this file If the value of the Header.FFVOldestCodeThatMayReadThisFile field is greater than 0x0000002A (42), programs that implement this structure specification ignore all other data in the file .oNE -> 0x0000002A (42) .oNETOC2 -> 0x0000001B (27).

      • getFcrLegacyFreeChunkList

        public FileChunkReference32 getFcrLegacyFreeChunkList()

        Gets or sets a file chunk reference. It MUST have a value of "FCR-Zero" FCR-Zero : Specifies a file chunk reference where all bits of the STP and CB fields are set to zero.

      • setFcrLegacyFreeChunkList

        public void setFcrLegacyFreeChunkList(FileChunkReference32 value)

        Gets or sets a file chunk reference. It MUST have a value of "FCR-Zero" FCR-Zero : Specifies a file chunk reference where all bits of the STP and CB fields are set to zero.

      • getFcrLegacyTransactionLog

        public FileChunkReference32 getFcrLegacyTransactionLog()

        Gets or sets a file chunk reference. It MUST be "FCRNil" FCR-Nil: Specifies a file chunk reference where all bits of the STP field are set to 1, and all bits of the CB field are set to zero.

      • setFcrLegacyTransactionLog

        public void setFcrLegacyTransactionLog(FileChunkReference32 value)

        Gets or sets a file chunk reference. It MUST be "FCRNil" FCR-Nil: Specifies a file chunk reference where all bits of the STP field are set to 1, and all bits of the CB field are set to zero.

      • getCTransactionsInLog

        public long getCTransactionsInLog()

        Gets or sets an unsigned integer that specifies the number of transactions in the transaction log. MUST NOT be zero.

      • setCTransactionsInLog

        public void setCTransactionsInLog(long value)

        Gets or sets an unsigned integer that specifies the number of transactions in the transaction log. MUST NOT be zero.

      • getCbLegacyExpectedFileLength

        public long getCbLegacyExpectedFileLength()

        Gets or sets an unsigned integer that MUST be zero, and MUST be ignored.

      • setCbLegacyExpectedFileLength

        public void setCbLegacyExpectedFileLength(long value)

        Gets or sets an unsigned integer that MUST be zero, and MUST be ignored.

      • getRgbPlaceholder

        public long getRgbPlaceholder()

        Gets or sets an unsigned integer that MUST be zero, and MUST be ignored.

      • setRgbPlaceholder

        public void setRgbPlaceholder(long value)

        Gets or sets an unsigned integer that MUST be zero, and MUST be ignored.

      • getFcrLegacyFileNodeListRoot

        public FileChunkReference32 getFcrLegacyFileNodeListRoot()

        Gets or sets a file chunk reference. It MUST be "FCR-Nil".

      • setFcrLegacyFileNodeListRoot

        public void setFcrLegacyFileNodeListRoot(FileChunkReference32 value)

        Gets or sets a file chunk reference. It MUST be "FCR-Nil".

      • getCbLegacyFreeSpaceInFreeChunkList

        public long getCbLegacyFreeSpaceInFreeChunkList()

        Gets or sets an unsigned integer that MUST be zero, and MUST be ignored.

      • setCbLegacyFreeSpaceInFreeChunkList

        public void setCbLegacyFreeSpaceInFreeChunkList(long value)

        Gets or sets an unsigned integer that MUST be zero, and MUST be ignored.

      • getFNeedsDefrag

        public boolean getFNeedsDefrag()

        Gets or sets a value indicating whether file needs defragmentation. MUST be ignored.

      • setFNeedsDefrag

        public void setFNeedsDefrag(boolean value)

        Gets or sets a value indicating whether file needs defragmentation. MUST be ignored.

      • getFRepairedFile

        public boolean getFRepairedFile()

        Gets or sets a value indicating whether file is repaired. MUST be ignored.

      • setFRepairedFile

        public void setFRepairedFile(boolean value)

        Gets or sets a value indicating whether file is repaired. MUST be ignored.

      • getFNeedsGarbageCollect

        public boolean getFNeedsGarbageCollect()

        Gets or sets a value indicating whether file needs garbage collection. MUST be ignored.

      • setFNeedsGarbageCollect

        public void setFNeedsGarbageCollect(boolean value)

        Gets or sets a value indicating whether file needs garbage collection. MUST be ignored.

      • getFHasNoEmbeddedFileObjects

        public boolean getFHasNoEmbeddedFileObjects()

        Gets or sets a value indicating whether file has no embedded file objects. MUST be zero, and MUST be ignored.

      • setFHasNoEmbeddedFileObjects

        public void setFHasNoEmbeddedFileObjects(boolean value)

        Gets or sets a value indicating whether file has no embedded file objects. MUST be zero, and MUST be ignored.

      • getGuidAncesto

        public Guid getGuidAncesto()

        Gets or sets a GUID that specifies the Header.GUIDFile field of the table of contents file, as specified by [MS-ONE] section 2.1.15, given by the following items : Table of contents file format -> Location of table of contents file Section file (.oNE) -> Table of contents file is located in the same directory as this file. Table of contents file (.oNETOC2) -> Table of contents file is located in the parent directory of this file. If the GUID is {00000000-0000-0000-0000-000000000000}, this field does not reference a table of contents file.

      • setGuidAncesto

        public void setGuidAncesto(Guid value)

        Gets or sets a GUID that specifies the Header.GUIDFile field of the table of contents file, as specified by [MS-ONE] section 2.1.15, given by the following items : Table of contents file format -> Location of table of contents file Section file (.oNE) -> Table of contents file is located in the same directory as this file. Table of contents file (.oNETOC2) -> Table of contents file is located in the parent directory of this file. If the GUID is {00000000-0000-0000-0000-000000000000}, this field does not reference a table of contents file.

      • getCrcName

        public long getCrcName()

        Gets or sets an unsigned integer that specifies the CRC value of the name of this revision store file.

      • setCrcName

        public void setCrcName(long value)

        Gets or sets an unsigned integer that specifies the CRC value of the name of this revision store file.

      • getFcrHashedChunkList

        public FileChunkReference64X32 getFcrHashedChunkList()

        Gets or sets a reference to a hashed chunk list (section 2.3.4). If the value of the FileChunkReference64x32 structure is "FCR-Zero" or "FCR-Nil", the hashed chunk list does not exist.

      • setFcrHashedChunkList

        public void setFcrHashedChunkList(FileChunkReference64X32 value)

        Gets or sets a reference to a hashed chunk list (section 2.3.4). If the value of the FileChunkReference64x32 structure is "FCR-Zero" or "FCR-Nil", the hashed chunk list does not exist.

      • getFcrTransactionLog

        public FileChunkReference64X32 getFcrTransactionLog()

        Gets or sets a reference to the first TransactionLogFragment structure The value MUST NOT be "FCR-Zero" and MUST NOT be "FCR-Nil".

      • setFcrTransactionLog

        public void setFcrTransactionLog(FileChunkReference64X32 value)

        Gets or sets a reference to the first TransactionLogFragment structure The value MUST NOT be "FCR-Zero" and MUST NOT be "FCR-Nil".

      • getFcrFileNodeListRoot

        public FileChunkReference64X32 getFcrFileNodeListRoot()

        Gets or sets a reference to a root file node list The MUST NOT be "FCR-Zero" and MUST NOT be "FCR-Nil".

      • setFcrFileNodeListRoot

        public void setFcrFileNodeListRoot(FileChunkReference64X32 value)

        Gets or sets a reference to a root file node list The MUST NOT be "FCR-Zero" and MUST NOT be "FCR-Nil".

      • getFcrFreeChunkList

        public FileChunkReference64X32 getFcrFreeChunkList()

        Gets or sets a reference to a FreeChunkListFragment structure If the value is "FCR-Zero" or "FCR-Nil", then the free chunk list does not exist.

      • setFcrFreeChunkList

        public void setFcrFreeChunkList(FileChunkReference64X32 value)

        Gets or sets a reference to a FreeChunkListFragment structure If the value is "FCR-Zero" or "FCR-Nil", then the free chunk list does not exist.

      • getCbExpectedFileLength

        public long getCbExpectedFileLength()

        Gets or sets an unsigned integer that specifies the size, in bytes, of this revision store file.

      • setCbExpectedFileLength

        public void setCbExpectedFileLength(long value)

        Gets or sets an unsigned integer that specifies the size, in bytes, of this revision store file.

      • getCbFreeSpaceInFreeChunkList

        public long getCbFreeSpaceInFreeChunkList()

        Gets or sets an unsigned integer that SHOULD specify the size, in bytes, of the free space specified by the free chunk list.

      • setCbFreeSpaceInFreeChunkList

        public void setCbFreeSpaceInFreeChunkList(long value)

        Gets or sets an unsigned integer that SHOULD specify the size, in bytes, of the free space specified by the free chunk list.

      • getGuidFileVersion

        public Guid getGuidFileVersion()

        Gets or sets file version GUID When either the value of cTransactionsInLog field or the GUID-DenyReadFileVersion field is being changed, file version GUID MUST be changed to a new GUID.

      • setGuidFileVersion

        public void setGuidFileVersion(Guid value)

        Gets or sets file version GUID When either the value of cTransactionsInLog field or the GUID-DenyReadFileVersion field is being changed, file version GUID MUST be changed to a new GUID.

      • getNFileVersionGeneration

        public long getNFileVersionGeneration()

        Gets or sets the number of times the file has changed. MUST be incremented when the file version GUID field changes.

      • setNFileVersionGeneration

        public void setNFileVersionGeneration(long value)

        Gets or sets the number of times the file has changed. MUST be incremented when the file version GUID field changes.

      • getGuidDenyReadFileVersion

        public Guid getGuidDenyReadFileVersion()

        Gets or sets GUID-DenyReadFileVersion When the existing contents of the file are being changed, excluding the Header structure of the file and unused storage blocks, GUID-DenyReadFileVersion MUST be changed to a new GUID.

      • setGuidDenyReadFileVersion

        public void setGuidDenyReadFileVersion(Guid value)

        Gets or sets GUID-DenyReadFileVersion When the existing contents of the file are being changed, excluding the Header structure of the file and unused storage blocks, GUID-DenyReadFileVersion MUST be changed to a new GUID.

      • getGrfDebugLogFlags

        public long getGrfDebugLogFlags()

        Gets or sets field that MUST be zero. MUST be ignored.

      • setGrfDebugLogFlags

        public void setGrfDebugLogFlags(long value)

        Gets or sets field that MUST be zero. MUST be ignored.

      • getFcrDebugLog

        public FileChunkReference64X32 getFcrDebugLog()

        Gets or sets reference that MUST be "FCR-Zero". MUST be ignored.

      • setFcrDebugLog

        public void setFcrDebugLog(FileChunkReference64X32 value)

        Gets or sets reference that MUST be "FCR-Zero". MUST be ignored.

      • getFcrAllocVerificationFreeChunkList

        public FileChunkReference64X32 getFcrAllocVerificationFreeChunkList()

        Gets or sets reference that MUST be "FCR-Zero". MUST be ignored.

      • setFcrAllocVerificationFreeChunkList

        public void setFcrAllocVerificationFreeChunkList(FileChunkReference64X32 value)

        Gets or sets reference that MUST be "FCR-Zero". MUST be ignored.

      • getBnCreated

        public long getBnCreated()

        Gets or sets an unsigned integer that specifies the build number of the application that created this revision store file.

      • setBnCreated

        public void setBnCreated(long value)

        Gets or sets an unsigned integer that specifies the build number of the application that created this revision store file.

      • getBnLastWroteToThisFile

        public long getBnLastWroteToThisFile()

        Gets or sets an unsigned integer that specifies the build number of the application that last wrote to this revision store file.

      • setBnLastWroteToThisFile

        public void setBnLastWroteToThisFile(long value)

        Gets or sets an unsigned integer that specifies the build number of the application that last wrote to this revision store file.

      • getBnOldestWritten

        public long getBnOldestWritten()

        Gets or sets an unsigned integer that specifies the build number of the oldest application that wrote to this revision store file.

      • setBnOldestWritten

        public void setBnOldestWritten(long value)

        Gets or sets an unsigned integer that specifies the build number of the oldest application that wrote to this revision store file.

      • getBnNewestWritten

        public long getBnNewestWritten()

        Gets or sets the build number of the newest application that wrote to this revision store file.

      • setBnNewestWritten

        public void setBnNewestWritten(long value)

        Gets or sets the build number of the newest application that wrote to this revision store file.

      • getRgbReserved

        public byte[] getRgbReserved()

        Gets or sets reserved field. MUST be zero. MUST be ignored.

      • setRgbReserved

        public void setRgbReserved(byte[] value)

        Gets or sets reserved field. MUST be zero. MUST be ignored.

      • isOne

        public boolean isOne()

        Gets a value indicating whether file format type is .oNE

      • isOnetoc2

        public boolean isOnetoc2()

        Gets a value indicating whether file format type is .oNETOC2

      • getCrc32AlgorithmProvider

        public Crc32 getCrc32AlgorithmProvider()

        Gets Cyclic Redundancy Check algorithm provider

      • toByteArray

        public byte[] toByteArray()

        The to byte array.

        Specified by:
        toByteArray in interface IBinarySerializable
        Returns:
        The T:byte[].
        Throws:
        com.aspose.ms.System.InvalidOperationException - Incorrect buffer size.
      • equals

        public boolean equals(Header other)

        The equals.

        Parameters:
        other - The other.
        Returns:
        The bool.
      • equals

        public boolean equals(Object other)
        Specified by:
        equals in interface com.aspose.ms.System.IEquatable<Header>
        Overrides:
        equals in class Object